@@ -44,57 +48,21 @@ Change into the base directory of this software and install the project dependen
...
@@ -44,57 +48,21 @@ Change into the base directory of this software and install the project dependen
Setting up the configuration
Setting up the configuration
----------------------------
----------------------------
By default the project is set up to run on a SQLite database.
Copy the ``.env.example`` file to ``.env`` and change the values accordingly.
You have to at least provide the ``SECRET_KEY`` and the ``DBPASS`` values
Create a file ``pv/local_settings.py`` and add at least the following line::
for Django to start. The file provides extensive comments on all the settings.
For a developments environment the defaults should be just fine if you use the
SECRET_KEY = 'secret key'
*steering-postgres* docker container from the *aura-web* repository. If you
want to create your own database on you local machine, you will have to use
(obviously replacing "secret key" with a key of your choice).
*steering* as the database and user name, or adopt the ``DB*`` values
accordingly.
Setting up PostgreSQL
---------------------
We recommend using PostgreSQL in order to be able to use the collation utf8mb64_unicode_ci and thus being able to display all languages.
To use PostgreSQL, add the following to your ``local_settings.py`` (before migrating) and add your credentials::
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': '',
'USER': '',
'PASSWORD': '',
'HOST': 'localhost',
'PORT': '5432'
}
}
Setting up MySQL
----------------
**Note:** When adding your database, make sure you **don't** use the collation utf8mb4_unicode_ci or you will get a key length error during migration. (use e.g. utf8_general_ci instead).
To use MySQL, add the following to your ``local_settings.py`` (before migrating)::