mirror of
https://github.com/th3r00t/pyShelf.git
synced 2026-04-28 01:59:35 -04:00
Updated readme, and installer
This commit is contained in:
20
README.md
vendored
20
README.md
vendored
@@ -1,4 +1,4 @@
|
|||||||
# pyShelf 0.3.0
|
# pyShelf 0.4.0
|
||||||
|
|
||||||
<p align="center"><b>Terminal based ebook server. Open source & Lightweight.</b></p>
|
<p align="center"><b>Terminal based ebook server. Open source & Lightweight.</b></p>
|
||||||
|
|
||||||
@@ -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.
|
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
|
## Current Features
|
||||||
|
* Custom Installer
|
||||||
* Recursive Scanning
|
* Recursive Scanning
|
||||||
* Fast database access
|
* Fast database access
|
||||||
* Django based frontend
|
* Django based frontend
|
||||||
@@ -17,7 +18,6 @@ Having used Calibre for hosting my eBook collection in the past, I found myself
|
|||||||
|
|
||||||
## Installation Example
|
## Installation Example
|
||||||
<a href="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a" target="_blank"><img src="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a.svg" /></a>
|
<a href="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a" target="_blank"><img src="https://asciinema.org/a/M739CljirFAf9nzeNyNO0113a.svg" /></a>
|
||||||
* In addition to the above steps you must now also make the requisite changes in config.json to reflect the connection to your postgresql server
|
|
||||||
<img src="https://raw.githubusercontent.com/th3r00t/pyShelf/development/src/interface/static/img/pyShelf_frontend_0_1_0.png" alt="Server Frontend" align="center" />
|
<img src="https://raw.githubusercontent.com/th3r00t/pyShelf/development/src/interface/static/img/pyShelf_frontend_0_1_0.png" alt="Server Frontend" align="center" />
|
||||||
|
|
||||||
## Further Installation & Support Information
|
## Further Installation & Support Information
|
||||||
@@ -48,25 +48,13 @@ _Before advancing version numbers be sure to set PROJECT_NUMBER in doxygen.conf
|
|||||||
|
|
||||||
## Configuration
|
## Configuration
|
||||||
|
|
||||||
### Nginx
|
All configuration is now handled by the installer.
|
||||||
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.
|
|
||||||
|
|
||||||
Running via the Django test server might be possible, albeit not recomended.
|
Running via the Django test server might be possible, albeit not recomended.
|
||||||
|
|
||||||
## In Progress
|
## In Progress
|
||||||
|
|
||||||
* Searching, & further organizational tools.
|
* Organizational tools.
|
||||||
* Docker image for those who need it.
|
* Docker image for those who need it.
|
||||||
* Improved cover image storage, and acquisition.
|
* Improved cover image storage, and acquisition.
|
||||||
|
|
||||||
|
|||||||
3
installer
vendored
3
installer
vendored
@@ -342,8 +342,7 @@ try:
|
|||||||
if copy_config:
|
if copy_config:
|
||||||
messages = messages + ["pyShelf site config copied to sites-available, and symlinked to sites-enabled"]
|
messages = messages + ["pyShelf site config copied to sites-available, and symlinked to sites-enabled"]
|
||||||
except Exception as e:
|
except Exception as e:
|
||||||
messages = messages + ["nginx site config not copied",
|
messages = messages + ["nginx site config not copied", "A nginx config for your install has been created \"pyshelf_nginx.conf\""]
|
||||||
"you are responsible for setting up your web server"]
|
|
||||||
sysinstall.make_wsgi_config(install_answers)
|
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"]
|
messages = messages + ["You should now import your books by running importBooks", "You can then start the interface with uwsgi --ini uwsgi.ini"]
|
||||||
|
|
||||||
|
|||||||
Reference in New Issue
Block a user