Add installing guide to the readme

newer-dal
LEdoian 3 years ago
parent 08cb53db96
commit 985e536dca

@ -18,7 +18,33 @@ Currently there is no documentation :-/
Installing Installing
--- ---
TODO :-/
1. Pull the repository to preferred location (`git clone
https://gitea.ledoian.cz/LEdoian/Wish.git <location>` should be sufficient).
2. Optionally create a virtualenv (the deployment script and example
configuration expect it in `venv` directory at repo root).
3. Install the requirements
4. Tweak and deploy the settings:
- Instance configuration template is in `conf/deploycfg.py` and should be
placed in `$XDG_CONFIG_DIR/wish/deploycfg.py` (or
`~/.config/wish/deploycfg.py` if `$XDG_CONFIG_DIR` is not set). Tweak to
your needs according to [Django
documentation](https://docs.djangoproject.com/en/4.0/ref/settings/).
- Configure a web reverse proxy and WSGI server to your liking. The `conf`
directory contains example configuration files for uWSGI, nginx and
systemd.
5. Verify the configuration using `./manage.py check --deploy`. If there are
relevant errors, tweak the configuration more.
6. If everything seems OK, start the systemd service and try reaching the site.
You will likely need to reference documentation of Django, uWSGI (or other WSGI
server implementation), web reverse proxy of your liking and your service manager.
If you deploy using git, have a virtualenv in `./venv/` and use systemd to run
the service, you can try to use the provided script `./deploy.sh` for
subsequent deploys. Keep in mind, however, that it is written so it WorksForMe™
and I do not guarantee that it will work for you. But I might be able to help
you and/or am open to changes, so feel free to send me questions and/or patches.
Licence Licence
--- ---

Loading…
Cancel
Save