diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..932c1688 --- /dev/null +++ b/.gitignore @@ -0,0 +1,20 @@ +### Python ### +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# Distribution / packaging +.Python +env/ +eggs/ +.eggs/ +*.egg-info/ +.installed.cfg +*.egg + +# calibre-web +*.db +*.log +config.ini + diff --git a/config.ini b/config.ini.example similarity index 100% rename from config.ini rename to config.ini.example diff --git a/config.ini_example b/config.ini_example deleted file mode 100644 index f1b18a87..00000000 --- a/config.ini_example +++ /dev/null @@ -1,12 +0,0 @@ -[General] -DB_ROOT = -APP_DB_ROOT = -MAIN_DIR = -LOG_DIR = -PORT = 8083 -NEWEST_BOOKS = 60 -[Advanced] -TITLE_REGEX = ^(A|The|An|Der|Die|Das|Den|Ein|Eine|Einen|Dem|Des|Einem|Eines)\s+ -DEVELOPMENT = 1 -PUBLIC_REG = 0 -UPLOADING = 1 diff --git a/readme.md b/readme.md index d1af5db6..2fb68d45 100755 --- a/readme.md +++ b/readme.md @@ -25,7 +25,7 @@ Also available as [Docker image](https://registry.hub.docker.com/u/janeczku/cali ## Quick start -1. Open config.ini and set DB_ROOT to the path of the folder where your Calibre library (metadata.db) lives +1. Rename `config.ini.example` to `config.ini` and set DB_ROOT to the path of the folder where your Calibre library (metadata.db) lives 2. To enable public user registration set PUBLIC_REG to 1 3. To enable uploading of PDF books set UPLOADING to 1 4. Execute the command: `python cps.py`