Update README with wiki changes

* Changed link to wiki
* Removed unneeded links (as uWSGI won't be supported)
* Added uvicorn to list of downloads
* Added --host flag to uvicorn command, as the server is only accessible from the host machine otherwise (and not from another in the local network)
pull/82/head
Simon Vandevelde 3 years ago committed by GitHub
parent 8bfdbc55a3
commit e86c85def7
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

@ -29,6 +29,7 @@ virtualenv -p python3 .venv # If doesn't work, try: virtualenv3 .venv
source .venv/bin/activate
pip install -r requirements.txt
pip install uvicorn[standard] # To run the server
```
# Configuration
@ -62,18 +63,14 @@ Now you can initialise our django app.
And you are done! You can now run the debug server just to see everything works as expected by running:
```
uvicorn etebase_server.asgi:application --port 8000
uvicorn etebase_server.asgi:application --port 8000 --host 0.0.0.0
```
Using the debug server in production is not recommended, so please read the following section for a proper deployment.
# Production deployment
There are more details about a proper production setup using Daphne and Nginx in the [wiki](https://github.com/etesync/server/wiki/Production-setup-using-Daphne-and-Nginx).
Etebase is based on Django so you should refer to one of the following
* The instructions of the Django project [here](https://docs.djangoproject.com/en/2.2/howto/deployment/wsgi/).
* Instructions from uwsgi [here](http://uwsgi-docs.readthedocs.io/en/latest/tutorials/Django_and_nginx.html).
There are more details about a proper production setup using uvicorn and Nginx in the [wiki](https://github.com/etesync/server/wiki/Production-setup-using-Nginx).
The webserver should also be configured to serve Etebase using TLS.
A guide for doing so can be found in the [wiki](https://github.com/etesync/server/wiki/Setup-HTTPS-for-Etebase) as well.

Loading…
Cancel
Save