diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 50 |
1 files changed, 3 insertions, 47 deletions
@@ -13,53 +13,9 @@ features are still lacking. Installation ------------ -- Generate a fresh virtual environment (recommended): - - virtualenv .venv - -- Install `fietsboek`: - - .venv/bin/pip install . - -- (Optionally: Install `lxml` to speed up GPX parsing) - - .venv/bin/pip install lxml - -- Adjust `production.ini` to your needs, mainly check the following settings: - - sqlalchemy.url - see https://docs.sqlalchemy.org/en/14/core/engines.html#database-urls - session_key - set this to a random secret which is used to sign session keys - available_locales - set this to the list of locales you want to support - (by default, English and German translations are shipped) - enable_account_registration - whether users should be able to create new accounts - (set this to false for a private instance) - pyramid.default_locale_name - set the default language - email.from - the address that Fietsboek email's will be sent from - email.smtp_url - the URL of the SMTP server to send emails - (smtp://host:port, smtp+ssl://host:port, smtp+starttls://host:port) - email.smtp_user, email.smtp_password - SMTP login information - -- Create the database tables: - - .venv/bin/alembic -c production.ini upgrade head - -- Create the admin user - - .venv/bin/fietsctl -c production.ini useradd --admin - -- Start Fietsboek: - - .venv/bin/pserve production.ini - -This runs Fietsboek using Pyramid's [Waitress](https://docs.pylonsproject.org/projects/waitress/en/stable/index.html) -server. If you need a better performance, read [the corresponding -section](https://docs.pylonsproject.org/projects/waitress/en/stable/index.html) -in the Pyramid documentation and set up Fietsboek using an alternative server, -such as `gunicorn` or `mod_wsgi`. - -Note that it is advised to use a reverse proxy in front of Fietsboek to handle -SSL. **Not setting up a SSL capable reverse proxy puts the security of your -users at risk!** +Setup instructions are in the documentation. You can either build it locally +using [Sphinx](https://www.sphinx-doc.org/), or view the generated version +online: https://kingdread.de/fietsboek/ Development ----------- |