Docker/AdventureLog
Docker/AdventureLog
1
0
Fork 0
mirror of https://github.com/seanmorley15/AdventureLog.git synced 2025-07-19 04:49:37 +02:00
Code Issues Releases Activity

Mass documentation spelling check, as well as improving the unraid installation guide, and some small changes to the docker installation guide.

Browse source
This commit is contained in:
Thunder 2025-01-28 23:23:47 -06:00
parent afdc894f23
commit defd97fc02
10 changed files with 75 additions and 70 deletions
Download patch file Download diff file Expand all files Collapse all files

6
documentation/docs/changelogs/v0-8-0.md
View file

@ -19,7 +19,7 @@ I’m thrilled to announce the release of **AdventureLog v0.8.0**, a huge update
### 🚗 Transportation ### 🚗 Transportation
- **New Transportation Edit Modal**: Includes detailed origin and destination location information for better trip planning. - **New Transportation Edit Modal**: Includes detailed origin and destination location information for better trip planning.
- **Autocomplete for Airport Codes**: Quickly find and add airport codes while planning transportations. - **Autocomplete for Airport Codes**: Quickly find and add airport codes while planning transportation.
- **New Transportation Card Design**: Redesigned for better clarity and aesthetics. - **New Transportation Card Design**: Redesigned for better clarity and aesthetics.
--- ---
@ -27,7 +27,7 @@ I’m thrilled to announce the release of **AdventureLog v0.8.0**, a huge update
### 📝 Notes and Checklists ### 📝 Notes and Checklists
- **New Modals for Notes and Checklists**: Simplified creation and editing of your notes and checklists. - **New Modals for Notes and Checklists**: Simplified creation and editing of your notes and checklists.
- **Delete Confirmation**: Added a confirmation step when deleting notes, checklists, or transportations to prevent accidental deletions. - **Delete Confirmation**: Added a confirmation step when deleting notes, checklists, or transportation to prevent accidental deletions.
--- ---
@ -41,7 +41,7 @@ I’m thrilled to announce the release of **AdventureLog v0.8.0**, a huge update
### 🗓️ Calendar ### 🗓️ Calendar
- **Calendar View**: View your adventures and transportations in a calendar layout. - **Calendar View**: View your adventures and transportation in a calendar layout.
- **ICS File Export**: Export your calendar as an ICS file for use with external apps like Google Calendar or Outlook. - **ICS File Export**: Export your calendar as an ICS file for use with external apps like Google Calendar or Outlook.
--- ---

2
documentation/docs/configuration/social_auth.md
View file

@ -1,6 +1,6 @@
# Social Authentication # Social Authentication
AdventureLog support autentication via 3rd party services and self-hosted identity providers. Once these services are enabled, users can log in to AdventureLog using their accounts from these services and link exising AdventureLog accounts to these services for easier access. AdventureLog support authentication via 3rd party services and self-hosted identity providers. Once these services are enabled, users can log in to AdventureLog using their accounts from these services and link existing AdventureLog accounts to these services for easier access.
The steps for each service varies so please refer to the specific service's documentation for more information. The steps for each service varies so please refer to the specific service's documentation for more information.

4
documentation/docs/configuration/social_auth/authentik.md
View file

@ -22,14 +22,14 @@ To enable Authentik as an identity provider, the administrator must first config
### AdventureLog Configuration ### AdventureLog Configuration
This configuration is done in the [Admin Panel](../../guides/admin_panel.md). You can either launch the pannel directly from the `Settings` page or navigate to `/admin` on your AdventureLog server. This configuration is done in the [Admin Panel](../../guides/admin_panel.md). You can either launch the panel directly from the `Settings` page or navigate to `/admin` on your AdventureLog server.
1. Login to AdventureLog as an administrator and navigate to the `Settings` page. 1. Login to AdventureLog as an administrator and navigate to the `Settings` page.
2. Scroll down to the `Administration Settings` and launch the admin panel. 2. Scroll down to the `Administration Settings` and launch the admin panel.
3. In the admin panel, navigate to the `Social Accounts` section and click the add button next to `Social applications`. Fill in the following fields: 3. In the admin panel, navigate to the `Social Accounts` section and click the add button next to `Social applications`. Fill in the following fields:
- Provider: `OpenID Connect` - Provider: `OpenID Connect`
- Provider ID: Autnentik Client ID - Provider ID: Authentik Client ID
- Name: `Authentik` - Name: `Authentik`
- Client ID: Authentik Client ID - Client ID: Authentik Client ID
- Secret Key: Authentik Client Secret - Secret Key: Authentik Client Secret

4
documentation/docs/configuration/social_auth/github.md
View file

@ -20,7 +20,7 @@ To enable GitHub as an identity provider, the administrator must first configure
### AdventureLog Configuration ### AdventureLog Configuration
This configuration is done in the [Admin Panel](../../guides/admin_panel.md). You can either launch the pannel directly from the `Settings` page or navigate to `/admin` on your AdventureLog server. This configuration is done in the [Admin Panel](../../guides/admin_panel.md). You can either launch the panel directly from the `Settings` page or navigate to `/admin` on your AdventureLog server.
1. Login to AdventureLog as an administrator and navigate to the `Settings` page. 1. Login to AdventureLog as an administrator and navigate to the `Settings` page.
2. Scroll down to the `Administration Settings` and launch the admin panel. 2. Scroll down to the `Administration Settings` and launch the admin panel.
@ -41,4 +41,4 @@ This configuration is done in the [Admin Panel](../../guides/admin_panel.md). Yo
4. Save the configuration. 4. Save the configuration.
Users should now be able to log in to AdventureLog using their GitHub account, and link it to exisiting accounts. Users should now be able to log in to AdventureLog using their GitHub account, and link it to existing accounts.

2
documentation/docs/configuration/updating.md
View file

@ -1,6 +1,6 @@
# Updating # 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! Updating AdventureLog when using docker can be quite easy. Run the following 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. Note: Make sure you are in the same directory as your `docker-compose.yml` file.

2
documentation/docs/guides/v0-7-1_migration.md
View file

@ -1,6 +1,6 @@
# AdventureLog v0.7.1 Migration # AdventureLog v0.7.1 Migration
In order to make installation easier, the AdventureLog v0.7.1 release has **removed the need for a seperate nginx container** and cofig to serve the media files. Instead, the media files are now served by an instance of nginx running in the same container as the Django application. In order to make installation easier, the AdventureLog v0.7.1 release has **removed the need for a separate nginx container** and config to serve the media files. Instead, the media files are now served by an instance of nginx running in the same container as the Django application.
## Docker Compose Changes ## Docker Compose Changes

38
documentation/docs/install/docker.md
View file

@ -25,31 +25,31 @@ wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-com
Here is a summary of the configuration options available in the `docker-compose.yml` file: Here is a summary of the configuration options available in the `docker-compose.yml` file:
<!-- make a table with colum name, is required, other --> <!-- make a table with column name, is required, other -->
### Frontend Container (web) ### Frontend Container (web)
| Name | Required | Description | Default Value | | Name | Required | Description | Default Value |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `PUBLIC_SERVER_URL` | Yes | What the frontend SSR server uses to connect to the backend. | http://server:8000 | | `PUBLIC_SERVER_URL` | Yes | What the frontend SSR server uses to connect to the backend. | ```http://server:8000``` |
| `ORIGIN` | Sometimes | Not needed if using HTTPS. If not, set it to the domain of what you will acess the app from. | http://localhost:8015 | | `ORIGIN` | Sometimes | Not needed if using HTTPS. If not, set it to the domain of what you will access the app from. | ```http://localhost:8015``` |
| `BODY_SIZE_LIMIT` | Yes | Used to set the maximum upload size to the server. Should be changed to prevent someone from uploading too much! Custom values must be set in **kiliobytes**. | Infinity | | `BODY_SIZE_LIMIT` | Yes | Used to set the maximum upload size to the server. Should be changed to prevent someone from uploading too much! Custom values must be set in **kilobytes**. | ```Infinity``` |
### Backend Container (server) ### Backend Container (server)
| Name | Required | Description | Default Value | | Name | Required | Description | Default Value |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
| `PGHOST` | Yes | Databse host. | db | | `PGHOST` | Yes | Database host. | ```db``` |
| `PGDATABASE` | Yes | Database. | database | | `PGDATABASE` | Yes | Database. | ```database``` |
| `PGUSER` | Yes | Database user. | adventure | | `PGUSER` | Yes | Database user. | ```adventure``` |
| `PGPASSWORD` | Yes | Database password. | changeme123 | | `PGPASSWORD` | Yes | Database password. | ```changeme123``` |
| `PGPORT` | No | Database port. | 5432 | | `PGPORT` | No | Database port. | ```5432``` |
| `DJANGO_ADMIN_USERNAME` | Yes | Default username. | admin | | `DJANGO_ADMIN_USERNAME` | Yes | Default username. | ```admin``` |
| `DJANGO_ADMIN_PASSWORD` | Yes | Default password, change after inital login. | admin | | `DJANGO_ADMIN_PASSWORD` | Yes | Default password, change after initial login. | ```admin``` |
| `DJANGO_ADMIN_EMAIL` | Yes | Default user's email. | admin@example.com | | `DJANGO_ADMIN_EMAIL` | Yes | Default user's email. | ```admin@example.com``` |
| `PUBLIC_URL` | Yes | This needs to match the outward port of the server and be accessible from where the app is used. It is used for the creation of image urls. | http://localhost:8016 | | `PUBLIC_URL` | Yes | This needs to match the outward port of the server and be accessible from where the app is used. It is used for the creation of image urls. | ```http://localhost:8016``` |
| `CSRF_TRUSTED_ORIGINS` | Yes | Need to be changed to the orgins where you use your backend server and frontend. These values are comma seperated. | http://localhost:8016 | | `CSRF_TRUSTED_ORIGINS` | Yes | Need to be changed to the origins where you use your backend server and frontend. These values are comma separated. | ```http://localhost:8016``` |
| `FRONTEND_URL` | Yes | This is the publically accessible url to the **frontend** container. This link should be accessable for all users. Used for email generation. | http://localhost:8015 | | `FRONTEND_URL` | Yes | This is the publicly accessible url to the **frontend** container. This link should be accessible for all users. Used for email generation. | ```http://localhost:8015``` |
## Running the Containers ## Running the Containers

2
documentation/docs/install/kustomize.md
View file

@ -25,7 +25,7 @@ You must [expose tailnet IPs to your cluster](https://tailscale.com/kb/1438/kube
## Getting Started ## Getting Started
Take a look at the [example config](https://github.com/seanmorley15/AdventureLog/blob/main/kustomization.yml) and modify it for your usecase. Take a look at the [example config](https://github.com/seanmorley15/AdventureLog/blob/main/kustomization.yml) and modify it for your use case.
## Environment Variables ## Environment Variables

2
documentation/docs/install/nginx_proxy_manager.md
View file

@ -21,7 +21,7 @@ Ensure that the Nginx Proxy Manager and AdventureLog containers are on the same
docker network create nginx-proxy-manager docker network create nginx-proxy-manager
``` ```
Add the folowing to the bottom of the `docker-compose.yml` file for the Nginx Proxy Manager service and the AdventureLog service. Add the following to the bottom of the `docker-compose.yml` file for the Nginx Proxy Manager service and the AdventureLog service.
```yaml ```yaml
networks: networks:

83
documentation/docs/install/unraid.md
View file

@ -1,66 +1,71 @@
# Installation with Unraid # Installation with Unraid
AdventureLog is available in the Unraid Community Applications store. You can install it by searching for `AdventureLog` in the Community Applications store, where you will find the frontend and the backend, the database can be found by searching `PostGIS`. AdventureLog is available in the Unraid Community Applications store. You can install it by searching for `AdventureLog` in the Community Applications store, where you will find the frontend and the backend. The database can be found by searching `PostGIS`.
Community Applications Page for AdventureLog: [AdventureLog on CA Store](https://unraid.net/community/apps?q=AdventureLog) Community Applications Page for AdventureLog: [AdventureLog on CA Store](https://unraid.net/community/apps?q=AdventureLog)\
Community Applications Page for PostGIS: [PostGIS on CA Store](https://unraid.net/community/apps?q=PostGIS) Community Applications Page for PostGIS: [PostGIS on CA Store](https://unraid.net/community/apps?q=PostGIS)
## Installation Configuration ## Installation Configuration
It is recommended to install the applications in the order of these instructions. - **Note:** It is recommended to install the applications in the order of these instructions, as failing to do so could cause issues.\
- Container names can be set to whatever you desire.
- Also ensure they are all on the same custom network so they can communicate with one another. You can create one by running the following command in your command line, with `example` being set to your desired name. This network will then show up for selection when making the apps/containers.
Also insure they are all on the same custom network so they can communicate to one another, you can create one by running the following command in your command line with example being set to your wanted name. This network will then showup for selection when making the apps/containers.
```bash ```bash
docker network create example docker network create example
``` ```
## Database ## Database
- To find the Database Application, search for `PostGIS` on the Unraid App Store and fill out the fields as shown below - Network type should be set to your **custom network**.
- Network type should be set to your custom network - There is **no** AdventureLog---Database app, to find the database application search for `PostGIS` on the Unraid App Store then add and fill out the fields as shown below
- Change the repository version to `postgis/postgis:15-3.3` - Change the repository version to `postgis/postgis:15-3.3`
- Ensure that the POSTGRES_DB, POSTGRES_USER, POSTGRES_PASSWORD are set in the PostGIS container, if not then add them as custom variables, the other variables are irrelevant for this setup and should be removed. - Ensure that the variables ```POSTGRES_DB```, ```POSTGRES_USER```, and ```POSTGRES_PASSWORD``` are set in the ```PostGIS``` container. If not, then add them as custom variables. The template should have ```POSTGRES_PASSWORD``` already and you will simply have to add ```POSTGRES_DB``` and ```POSTGRES_USER```.
- The forwarded port of ```5012``` is not needed unless you plan to access the database outside of the container's network.
| Name | Required | Description | Default Value | | Name | Required | Description | Default Value |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | ------------------- | -------- | -------------------------------------------------------------------------------- | --------------- |
| `POSTGRES_DB` | Yes | What the name of the database in PostGIS will be. | N/A | | `POSTGRES_DB` | Yes | The name of the database in PostGIS. | `N/A` |
| `POSTGRES_USER` | Yes | Name of the user generated on first start that will have access to the database | N/A | | `POSTGRES_USER` | Yes | Name of the user generated on first start that will have access to the database. | `N/A` |
| `POSTGRES_PASSWORD` | Yes | Password of the user that will be generated on first start | N/A | | `POSTGRES_PASSWORD` | Yes | Password of the user that will be generated on first start. | `N/A` |
![/static/img/unraid-config-2.png](/unraid-config-2.png) - Here's some visual instructions of how to configure the database template, click the image to open larger version in new tab.\
[![/static/img/unraid-config-2.png](/unraid-config-2.png)](/unraid-config-2.png)
## Backend ## Backend
- Network type should be set to your custom network - Network type should be set to your **custom network**.
- **Note:** If you're running the server in a docker network that is other than "host" (for example "bridge") than you need to add the IP of the host machine in the CSRF Trusted Origins variable instead of using localhost, this is only necessary when accessing locally, otherwise you will use the domain name. - **Note:** If you're running the server in a docker network that is other than "host" (for example "bridge"), then you need to add the IP of the host machine in the CSRF Trusted Origins variable instead of using localhost. This is only necessary when accessing locally, otherwise you will use the domain name.
| Name | Required | Description | Default Value | | Name | Required | Description | Default Value |
| ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------- |
| `API Port` | Yes | This is the port of the backend. This is a port not a variable. | 8016 | | `API Port` | Yes | This is the port of the backend. This is a port, not a variable. | `8016` |
| `SECRET_KEY` | Yes | Secret Backend Key. Change to anything. | CHANGEME | | `PGHOST` | Yes | This is how the backend will access the database. Use the database container's name. | `N/A` |
| `PGHOST` | Yes | This is how the backend will access the database, use the database containers name. | PostGIS | | `PGDATABASE` | Yes | Name of the database in PostGIS to access. | `N/A` |
| `PGDATABASE` | Yes | Name of the database in PostGIS to access. | database | | `PGUSER` | Yes | Name of the user to access with. This is the same as the variable in the database. | `N/A` |
| `PGUSER` | Yes | Name of the User to access with. This is the same as the variable in the database. | adventure | | `PGPASSWORD` | Yes | Password of the user it's accessing with. This is the same as the variable in the database. | `N/A` |
| `PGPASSWORD` | Yes | Password of the User it's accessing with. This is the same as the variable in the database. | changeme123 | | `SECRET_KEY` | Yes | Secret Backend Key. Change to anything. | `N/A` |
| `PGPORT` | No | Port to access the database at. | 5432 | | `DJANGO_ADMIN_USERNAME` | Yes | Default username for admin access. | `admin` |
| `DJANGO_ADMIN_USERNAME` | Yes | Default username for admin access. | admin | | `DJANGO_ADMIN_EMAIL` | Yes | Default admin user's email. **Note:** You cannot make more than one user with each email. | `N/A` |
| `DJANGO_ADMIN_PASSWORD` | Yes | Default password for admin access, change after inital login. | admin | | `DJANGO_ADMIN_PASSWORD` | Yes | Default password for admin access. Change after initial login. | `N/A` |
| `DJANGO_ADMIN_EMAIL` | Yes | Default admin user's email. **Note:** You cannot make more than one user with each email. | admin@example.com | | `PUBLIC_URL` | Yes | This needs to match how you will connect to the backend, so either local ip with matching port or domain. It is used for the creation of image URLs. | `http://IP_ADDRESS:8016` |
| `PUBLIC_URL` | Yes | This needs to match how you will connect to the backend, so either localhost with matching port or domain. It is used for the creation of image urls. | http://localhost:8016 | | `FRONTEND_URL` | Yes | This needs to match how you will connect to the frontend, so either local ip with matching port or domain. This link should be available for all users. Used for email generation. | `http://IP_ADDRESS:8015` |
| `CSRF_TRUSTED_ORIGINS` | Yes | This needs to be changed to the urls of how you connect to your backend server and frontend. These values are comma seperated. | http://localhost:8016 | | `CSRF_TRUSTED_ORIGINS` | Yes | This needs to be changed to the URLs of how you connect to your backend server and frontend. These values are comma-separated and usually the same as the 2 above values. | `http://IP_ADDRESS:8016,http://IP_ADDRESS:8015` |
| `FRONTEND_URL` | Yes | This needs to match how you will connect to the frontend, so either localhost with matching port or domain. This link should be available for all users. Used for email generation. | http://localhost:8015 |
![/static/img/unraid-config-1.png](/unraid-config-1.png) - Here's some visual instructions of how to configure the backend template, click the image to open larger version in new tab.\
[![static/img/unraid-config-1.png](/unraid-config-1.png)](/unraid-config-1.png)
## Frontend ## Frontend
- By default, the frontend connects to the backend using `http://server:8000`. This will work if both the frontend and backend are on the same network and the backend is named server. Otherwise, you’ll need to configure it to use the exposed port (default: 8016). - Network type should be set to your **custom network**.
- **Note:** The default value for ```PUBLIC_SERVER_URL``` is ```http://IP_ADDRESS:8000```, however ```IP_ADDRESS``` **should be changed** to the name of the backend container for simplicity.
| Name | Required | Description | Default Value | | Name | Required | Description | Default Value |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- | | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |
| `WEB UI Port` | Yes | The port of the frontend. This is not a variable. | 8015 | | `WEB UI Port` | Yes | The port of the frontend. This is not a variable. | `8015` |
| `PUBLIC_SERVER_URL` | Yes | What the frontend SSR server uses to connect to the backend. Change server to the name of the backend container. | http://server:8000 | | `PUBLIC_SERVER_URL` | Yes | What the frontend SSR server uses to connect to the backend. Change `IP_ADDRESS` to the name of the backend container. | `http://IP_ADDRESS:8000` |
| `ORIGIN` | Sometimes | Set to the URL you will access the frontend from such as localhost with corret port or set it to the domain of what you will acess the app from. | http://localhost:8015 | | `ORIGIN` | Sometimes| Set to the URL you will access the frontend from, such as localhost with correct port, or set it to the domain of what you will access the app from. | `http://IP_ADDRESS:8015` |
| `BODY_SIZE_LIMIT` | Yes | Used to set the maximum upload size to the server. Should be changed to prevent someone from uploading too much! Custom values must be set in **kiliobytes**. | Infinity | | `BODY_SIZE_LIMIT` | Yes | Used to set the maximum upload size to the server. Should be changed to prevent someone from uploading too much! Custom values must be set in **kilobytes**. | `Infinity` |
![/static/img/unraid-config-3.png](/unraid-config-3.png) - Here's some visual instructions of how to configure the frontend template, click the image to open larger version in new tab.\
[![/static/img/unraid-config-3.png](/unraid-config-3.png)](/unraid-config-3.png)