summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorDashie <dashie@sigpipe.me>2019-09-29 08:54:27 +0200
committerDashie <dashie@sigpipe.me>2019-09-29 08:54:27 +0200
commitcf367939cf3255c9d36352abdd90c8165666c845 (patch)
tree5ad1de20afbd481531c429cbd4c15dd111cac80f /docs
parent1967d7ce91bc2a012e96925f33a14ab4319d9dd2 (diff)
Don't use our own custom variables but the ones from flask/libs
Diffstat (limited to 'docs')
-rw-r--r--docs/installation/configuration.rst98
-rw-r--r--docs/installation/docker.rst2
-rw-r--r--docs/installation/index.rst2
3 files changed, 51 insertions, 51 deletions
diff --git a/docs/installation/configuration.rst b/docs/installation/configuration.rst
index 5234b694..1b51efa0 100644
--- a/docs/installation/configuration.rst
+++ b/docs/installation/configuration.rst
@@ -27,55 +27,55 @@ You can use `production_secret_sample.py` as example, naming them `whatyouwant_s
Configuration keys and definitions
----------------------------------
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| Key | Environment key | Default value | Description |
-+=========================+===========================+====================================================+===========================================================================+
-| TESTING | APP_TESTING | False | Used only for unit tests |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| DEBUG | APP_DEBUG | False | Used in development mode |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| REGISTRATION_ENABLED | APP_REGISTRATION | True | Allow user registration |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SECRET_KEY | APP_SECRET_KEY | None | Used for various security things in Flask |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SECURITY_PASSWORD_SALT | APP_SEC_PASS_SALT | None | Used for salting the users passwords |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SQLALCHEMY_DATABASE_URI | APP_DB_URI | postgresql+psycopg2://postgres@localhost/reel2bits | Database connection chain |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SQLALCHEMY_ECHO | APP_DB_ECHO | False | Do SQLAlchemy needs to echo every queries, useful in dev/debug |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SECURITY_CONFIRMABLE | APP_SEC_CONFIRMABLE | True | Should users have to confirm their email address |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| BABEL_DEFAULT_LOCALE | APP_API_DEFAULT_LOCALE | en | Backend default locale |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| BABEL_DEFAULT_TIMEZONE | APP_API_DEFAULT_TIMEZONE | UTC | Backend default timezone, might have no effect |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| AUDIOWAVEFORM_BIN | APP_AUDIOWAVEFORM_BIN | /usr/local/bin/audiowaveform | Path to the Audiowaveform tool |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SENTRY_DSN | APP_SENTRY_DSN | None | If you use sentry you can define your DSN here |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| CELERY_BROKER_URL | APP_CELERY_BROKER_URL | redis://127.0.0.1:6379/0 | Ideally the same as the following |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| CELERY_RESULT_BACKEND | APP_CELERY_RESULT_BACKEND | redis://127.0.0.1:6379/0 | |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| AP_DOMAIN | APP_AP_DOMAIN | localhost | The domain you uses for your instance, needed even if AP_ENABLED is False |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| AP_ENABLED | APP_AP_ENABLED | False | Is the ActivityPub backend active |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| SOURCES_REPOSITORY_URL | APP_SRCS_REPO_URL | Url to the source code | You should set your own repo url if you have done any customisation |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| MAIL_SERVER | APP_MAIL_SERVER | localhost | Mail server IP or DNS |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| MAIL_PORT | APP_MAIL_PORT | 25 | Mail server port |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| MAIL_USE_TLS | APP_MAIL_USE_TLS | False | Mail server is using TLS ? |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| MAIL_USE_SSL | APP_MAIL_USE_SSL | False | Mail server is using SSL ? |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| MAIL_USERNAME | APP_MAIL_USERNAME | None | Mail server username |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
-| MAIL_PASSWORD | APP_MAIL_PASSWORD | None | Mail server password |
-+-------------------------+---------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| Key | Default value | Description |
++=========================+====================================================+===========================================================================+
+| TESTING | False | Used only for unit tests |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| DEBUG | False | Used in development mode |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| REGISTRATION_ENABLED | True | Allow user registration |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SECRET_KEY | None | Used for various security things in Flask |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SECURITY_PASSWORD_SALT | None | Used for salting the users passwords |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SQLALCHEMY_DATABASE_URI | postgresql+psycopg2://postgres@localhost/reel2bits | Database connection chain |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SQLALCHEMY_ECHO | False | Do SQLAlchemy needs to echo every queries, useful in dev/debug |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SECURITY_CONFIRMABLE | True | Should users have to confirm their email address |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| BABEL_DEFAULT_LOCALE | en | Backend default locale |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| BABEL_DEFAULT_TIMEZONE | UTC | Backend default timezone, might have no effect |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| AUDIOWAVEFORM_BIN | /usr/local/bin/audiowaveform | Path to the Audiowaveform tool |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SENTRY_DSN | None | If you use sentry you can define your DSN here |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| CELERY_BROKER_URL | redis://127.0.0.1:6379/0 | Ideally the same as the following |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| CELERY_RESULT_BACKEND | redis://127.0.0.1:6379/0 | |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| AP_DOMAIN | localhost | The domain you uses for your instance, needed even if AP_ENABLED is False |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| AP_ENABLED | False | Is the ActivityPub backend active |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| SOURCES_REPOSITORY_URL | Url to the source code | You should set your own repo url if you have done any customisation |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| MAIL_SERVER | localhost | Mail server IP or DNS |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| MAIL_PORT | 25 | Mail server port |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| MAIL_USE_TLS | False | Mail server is using TLS ? |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| MAIL_USE_SSL | False | Mail server is using SSL ? |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| MAIL_USERNAME | None | Mail server username |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
+| MAIL_PASSWORD | None | Mail server password |
++-------------------------+----------------------------------------------------+---------------------------------------------------------------------------+
Upload paths
------------
diff --git a/docs/installation/docker.rst b/docs/installation/docker.rst
index b07746ed..d436de26 100644
--- a/docs/installation/docker.rst
+++ b/docs/installation/docker.rst
@@ -58,7 +58,7 @@ Create your env file:
chmod 600 .env # reduce permissions on the .env file since it contains sensitive data
sudo nano .env
-Ensure to edit it to match your needs (this file is heavily commented), in particular ``APP_SECRET_KEY``, ``APP_SEC_PASS_SALT`` or ``AP_DOMAIN``.
+Ensure to edit it to match your needs (this file is heavily commented), in particular ``SECRET_KEY``, ``SECURITY_PASSWORD_SALT`` or ``REEL2BITS_HOSTNAME``.
You should take a look at the `configuration reference <https://docs-develop.reel2bits.org/installation/configuration.html>`_ for more detailed information regarding each setting.
Deploy a frontend build.
diff --git a/docs/installation/index.rst b/docs/installation/index.rst
index d1518412..c0b26ef3 100644
--- a/docs/installation/index.rst
+++ b/docs/installation/index.rst
@@ -117,7 +117,7 @@ On non-docker deployments, run the following commands:
.. note::
- The resulting file should not contain any variable such as ``${APP_AP_DOMAIN}``.
+ The resulting file should not contain any variable such as ``${REEL2BITS_HOSTNAME}``.
You can check that using this command::
grep '${' /etc/nginx/sites-available/reel2bits.conf