mirrors/calibre-web
1
0
Fork 0
mirror of https://github.com/janeczku/calibre-web synced 2025-08-07 14:36:51 +00:00
Code Issues Releases Wiki Activity

Updated Developer's corner (markdown)

A Holt 2023-08-06 11:25:08 -04:00
parent c428a5571a
commit 8bb81dba0f
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
Developer's-corner.md

@ -6,12 +6,12 @@ Generate a new .py file in the `cps/metadata_provider`. The file will be read du
Don't forget to add your file to the excluded files during update (check next chapter).
## Exclude files from being overwritten during update
If you have extended Calibre-Web somehow with new files this files will be overwritten during the next manual run of programm internal updater.
To prevent this, add your files in the `exclude.txt` file in the root directory of Calibre-Web. Please use one file or directory per line. Calibre-Web's root folder acts as root folder for this file. **/** or **\** can act as path seperators, pathes with spaces can be enclosed by **"** or **'**. Per default all Calibre-Web settings databases and default logfiles are excluded from beeing overwritten.\
If you have extended Calibre-Web somehow with new files, these files will be overwritten during the next manual run of program internal updater.
To prevent this, add your files in the `exclude.txt` file in the root directory of Calibre-Web. Please use one file or directory per line. Calibre-Web's root folder acts as root folder for this file. **/** or **\** can act as path separators, paths with spaces can be enclosed by **"** or **'**. By default all Calibre-Web settings databases and default logfiles are excluded from being overwritten.\
Examples:\
`/logfile`\
Will exclude a file or a folder named **logfile** from beeing overwritten during update process.\
Will exclude a file or a folder named **logfile** from being overwritten during update process.\
`/random path/except.txt`\
Will exclude a file named **except.txt** in the random path directory from beeing overwritten during update process.\
Will exclude a file named **except.txt** in the random path directory from being overwritten during update process.
To check if anything works out well a dry run of the updater can be started by starting Calibre-Web with the `-d` parameter. Calibre-Web will check beside several other stuff if all files in exclude.txt are available.
To check if anything works out well, a dry run of the updater can be started by starting Calibre-Web with the `-d` parameter. Calibre-Web will check beside several other stuff if all files in exclude.txt are available.