Knah-Tsaeb/Soshot
1
0
Fork 0
Code Issues 5 Pull requests Projects Releases Wiki Activity

Update doc

Browse source
This commit is contained in:
Knah Tsaeb 2024-09-18 10:04:22 +02:00
parent 588fa13639
commit f811b8c499
1 changed files with 29 additions and 66 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

95
README.md
View file

@ -99,73 +99,36 @@ You can use a web interface (if option "use web gui" is set to true), https://sh
Or you can modify config file /datas/config.json.
#### Accept only request from 127.0.0.1
```json
{
"onlyLocalServer": true,
"webPage": false,
"log": true,
"alwaysMakePdf": false,
"icoSize": 48,
"expireCache": 12,
"maxGenPerBatch": 5,
"permitType": [],
"password": null,
"key": null,
"chromePath": null,
"fileFormat": "jpeg"
}
```
Default : true
ShoShot only work for local machine, return 404 if use with remote machine.
#### Use web gui
Default : false
Soshot only work with endpoint /api. Return 404 if endpoint is not /api
#### Use log
Default : true
Not implemented yet.
#### Always make PDF
Default : false
If true, SoShot make a complete webshot and PDF of page.
#### Favicon size
Default : 48
Define size of favicon.
#### Permit type of webshot
Default : none
Select authorized size or type of webshot.
#### Cache expiration (for web GUI) in hour
Default : 12
Not implemented yet.
#### Maximum work per batch
Default : 5
Foreach cron task as launch, SoShot make 5 webshot.
#### Api key
Default : random string, lenght 12
!!! DANGER !!!
If you change key, all previous generation will be invalid. Soshot re make all previous generation.
#### Password
Default : null
Password for admin interface. No min or max character.
#### Chrome path
Default : empty
If path of Chrome/Chromium is not in PATH, you can define here.
| Option | Type | Default | Description |
| --- | --- | --- | --- |
| onlyLocalServer | bool | true | ShoShot only work for local machine, return 404 if use with remote machine |
| webPage | bool | false | Soshot only work with endpoint /api. Return 404 if not |
| log | bool | true | Not implemented yet |
| alwaysMakePdf | bool | false | If true, SoShot make a complete webshot and PDF of page |
| icoSize | int | 48 | Define size of favicon |
| expireCache | int | 12 | Not implemented yet |
| permitType | array | null | Select authorized size or type of webshot |
| maxGenPerBatch | int | 5 | Foreach cron task as launch, SoShot make 5 webshot |
| key | string | 12 | !!! DANGER !!! If you change key, all previous generation will be invalid. Soshot re make all previous generationt |
| password | string | null | Password for admin interface. No min or max character |
| chromePath | string | null | If path of Chrome/Chromium is not in PATH, you can define here |
## Usage