diff --git a/README.md b/README.md index 9d8fe31..48fb825 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# pyShelf 0.3.0 +# pyShelf 0.4.0
Terminal based ebook server. Open source & Lightweight.
@@ -7,6 +7,7 @@ Having used Calibre for hosting my eBook collection in the past, I found myself frustrated having to install X on my server, or manage my library externally, Thus I have decided to spin up my own. ## Current Features +* Custom Installer * Recursive Scanning * Fast database access * Django based frontend @@ -17,7 +18,6 @@ Having used Calibre for hosting my eBook collection in the past, I found myself ## Installation Example
## Further Installation & Support Information
@@ -48,25 +48,13 @@ _Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf
## Configuration
-### Nginx
-Included is a default nginx config file {pyshelf_nginx.conf}. This file should be sufficient to get you up and running. You are required to change the location alias's to reflect your pyshelf install folder leaving everything after /frontend intact.
-
-Further resources for nginx setup may be found @ [This nginx, django, & uwsgi, guide](https://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html)
-
-### uwsgi
-Inside uwsgi.ini you should make changes to reflect your install directory, and the port you wish uwsgi to listen on. Alternativly you can make the requisite changes to listen on a socket instead. This change would also require a change to the pyshelf_nginx.conf file as well.
-
-### pyShelf
-User configuration is contained within config.json in the project root. You must set book_path to the location of your books, and change the database connection details to match your environment.
-
-## Misc
-Django has been implemented to power the frontend experience, and web based database maintenance. A properly configured web server is required for hosting the frontend, and a PostgreSQL server for the database, configuration of these servers is outside of the scope of this readme.
+All configuration is now handled by the installer.
Running via the Django test server might be possible, albeit not recomended.
## In Progress
-* Searching, & further organizational tools.
+* Organizational tools.
* Docker image for those who need it.
* Improved cover image storage, and acquisition.
diff --git a/installer b/installer
index 96a84fd..71ad7a0 100644
--- a/installer
+++ b/installer
@@ -342,8 +342,7 @@ try:
if copy_config:
messages = messages + ["pyShelf site config copied to sites-available, and symlinked to sites-enabled"]
except Exception as e:
- messages = messages + ["nginx site config not copied",
- "you are responsible for setting up your web server"]
+ messages = messages + ["nginx site config not copied", "A nginx config for your install has been created \"pyshelf_nginx.conf\""]
sysinstall.make_wsgi_config(install_answers)
messages = messages + ["You should now import your books by running importBooks", "You can then start the interface with uwsgi --ini uwsgi.ini"]