mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-07-19 12:59:36 +02:00
Migration to new documentation and information site
This commit is contained in:
parent
8e5a20ec62
commit
17d8784d8c
59 changed files with 1967 additions and 11276 deletions
10
documentation/docs/configuration/analytics.md
Normal file
10
documentation/docs/configuration/analytics.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
# Umami Analytics (optional)
|
||||
|
||||
Umami Analytics is a free, open-source, and privacy-focused web analytics tool that can be used as an alternative to Google Analytics. Learn more about Umami Analytics [here](https://umami.is/).
|
||||
|
||||
To enable Umami Analytics for your AdventureLog instance, you can set the following variables in your `docker-compose.yml` under the `web` service:
|
||||
|
||||
```yaml
|
||||
PUBLIC_UMAMI_SRC=https://cloud.umami.is/script.js # If you are using the hosted version of Umami
|
||||
PUBLIC_UMAMI_WEBSITE_ID=
|
||||
```
|
10
documentation/docs/configuration/disable_registration.md
Normal file
10
documentation/docs/configuration/disable_registration.md
Normal file
|
@ -0,0 +1,10 @@
|
|||
# Disable Registration
|
||||
|
||||
To disable registration, you can set the following variable in your docker-compose.yml under the server service:
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- DISABLE_REGISTRATION=True
|
||||
# OPTIONAL: Set the message to display when registration is disabled
|
||||
- DISABLE_REGISTRATION_MESSAGE='Registration is disabled for this instance of AdventureLog.'
|
||||
```
|
24
documentation/docs/configuration/email.md
Normal file
24
documentation/docs/configuration/email.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Change Email Backend
|
||||
|
||||
To change the email backend, you can set the following variable in your docker-compose.yml under the server service:
|
||||
|
||||
## Using Console (default)
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- EMAIL_BACKEND='console'
|
||||
```
|
||||
|
||||
## With SMTP
|
||||
|
||||
```yaml
|
||||
environment:
|
||||
- EMAIL_BACKEND='email'
|
||||
- EMAIL_HOST='smtp.gmail.com'
|
||||
- EMAIL_USE_TLS=False
|
||||
- EMAIL_PORT=587
|
||||
- EMAIL_USE_SSL=True
|
||||
- EMAIL_HOST_USER='user'
|
||||
- EMAIL_HOST_PASSWORD='password'
|
||||
- DEFAULT_FROM_EMAIL='user@example.com'
|
||||
```
|
24
documentation/docs/configuration/updating.md
Normal file
24
documentation/docs/configuration/updating.md
Normal file
|
@ -0,0 +1,24 @@
|
|||
# Updating
|
||||
|
||||
Updating AdventureLog when using docker can be quite easy. Run the folowing commands to pull the latest version and restart the containers. Make sure you backup your instance before updating just in case!
|
||||
|
||||
Note: Make sure you are in the same directory as your `docker-compose.yml` file.
|
||||
|
||||
```bash
|
||||
docker compose pull
|
||||
docker compose up -d
|
||||
```
|
||||
|
||||
## Updating the Region Data
|
||||
|
||||
Region and Country data in AdventureLog is provided by an open source project: [dr5hn/countries-states-cities-database](https://github.com/dr5hn/countries-states-cities-database). If you would like to update the region data in your AdventureLog instance, you can do so by running the following command. This will make sure your database is up to date with the latest region data for your version of AdventureLog. For security reasons, the region data is not automatically updated to the latest and is release version is controlled in the `settings.py` file.
|
||||
|
||||
```bash
|
||||
docker exec -it <container> bash
|
||||
```
|
||||
|
||||
Once you are in the container run the following command to resync the region data.
|
||||
|
||||
```bash
|
||||
python manage.py download-countries
|
||||
```
|
Loading…
Add table
Add a link
Reference in a new issue