diff --git a/README.md b/README.md index ea5a5b7..809ca33 100644 --- a/README.md +++ b/README.md @@ -24,24 +24,10 @@ Django 3.0 Calibre 4.13 (I have not tested it with anything else atm, will be resolved later) # how to use: -1. clone repo -2. Remove the `.bak` from `./CalibreWebCompanion/settings.json.bak` and `db.sqlite3.bak` -3. Edit `./CalibreWebCompanion/settings.json`. Definitely change the secret key -4. Not sure if the db needs to be regenerated, but we'll see later __!!!!!!!!!!__ -5. pip install -r requirements.txt -6. install gunicorn and nginx -7. move this nginx.conf to /etc/nginx -8. make whatever user nginx runs as (in this case, massiveatoms) the owner of calibredir -9. give execute permissions to parent of calibredir -10. cd to repo, run `gunicorn CalibreWebCompanion.wsgi` -11. start nginx `sudo systemctl restart nginx` +1. [Docker setup](./deployment/instructions.md#user-content-docker-detup) +2. [Non Docker setup](./deployment/instructions.md#user-content-non-docker-detup) - - -`./CalibreWebCompanion` -run `./manage.py runserver` - # Ignore pretty much everything below if you're not working on the project # Profiling @@ -74,7 +60,8 @@ You can then go to [http://localhost:8089/](http://localhost:8089/) to see live - [ ] cache with vary headers - [ ] localisation - [ ] Beautifying template (only works well on 720p, no other viewports) -- [ ] Setup email functionality +- [ ] Setup email functionality (atm, there's only a dummy one, and you can't reset passwords) +- [ ] isolate the styling and templates, so we can swap them out by just swapping directory content