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

Migration to new documentation and information site

Browse source
This commit is contained in:
Sean Morley 2024-11-26 10:31:25 -05:00
parent 8e5a20ec62
commit 17d8784d8c
59 changed files with 1967 additions and 11276 deletions
Download patch file Download diff file Expand all files Collapse all files

55
documentation/docs/install/docker.md Normal file
View file

@ -0,0 +1,55 @@
# Docker 🐋
Docker is the preferred way to run AdventureLog on your local machine. It is a lightweight containerization technology that allows you to run applications in isolated environments called containers.
**Note**: This guide mainly focuses on installation with a linux based host machine, but the steps are similar for other operating systems.
## Prerequisites
- Docker installed on your machine/server. You can learn how to download it [here](https://docs.docker.com/engine/install/).
## Getting Started
Get the `docker-compose.yml` file from the AdventureLog repository. You can download it from [here](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose.yml) or run this command to download it directly to your machine:
```bash
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.yml
```
## Configuration
Here is a summary of the configuration options available in the `docker-compose.yml` file:
<!-- make a table with colum name, is required, other -->
### Frontend Container (web)
| Name | Required | Description | Default Value |
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------- |
| `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 |
| `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 |
### Backend Container (server)
| Name | Required | Description | Default Value |
| ----------------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------- |
| `PGHOST` | Yes | Databse host. | db |
| `PGDATABASE` | Yes | Database. | database |
| `PGUSER` | Yes | Database user. | adventure |
| `PGPASSWORD` | Yes | Database password. | changeme123 |
| `DJANGO_ADMIN_USERNAME` | Yes | Default username. | admin |
| `DJANGO_ADMIN_PASSWORD` | Yes | Default password, change after inital login. | admin |
| `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' |
| `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 |
| `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' |
## Running the Containers
To start the containers, run the following command:
```bash
docker compose up -d
```
Enjoy AdventureLog! 🎉

12
documentation/docs/install/getting_started.md Normal file
View file

@ -0,0 +1,12 @@
# Install Options for AdventureLog
AdventureLog can be installed in a variety of ways. The following are the most common methods:
- [Docker](docker.md) 🐳
- [Proxmox LXC](proxmox_lxc.md) 🐧
- [Synology NAS](synology_nas.md) ☁️
### Other Options
- [Nginx Proxy Manager](nginx_proxy_manager.md) 🛡
- [Traefik](traefik.md) 🚀

48
documentation/docs/install/nginx_proxy_manager.md Normal file
View file

@ -0,0 +1,48 @@
# Installation with Nginx Proxy Manager
Nginx Proxy Manager is a simple and powerful tool that allows you to manage Nginx proxy hosts and SSL certificates. It is designed to be easy to use and configure, and it integrates well with Docker.
It is fairly simple to set up Nginx Proxy Manager with AdventureLog.
## Deploy AdventureLog using Docker
View the [Docker installation guide](docker.md) for instructions on how to deploy AdventureLog using Docker.
## Ensure Correct Environment Variables
- `ORIGIN` - The domain where you will be hosting AdventureLog. This is where the **frontend** will be served from.
- `PUBLIC_URL` - 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.
## Setup Docker Network
Ensure that the Nginx Proxy Manager and AdventureLog containers are on the same Docker network. You can create a new network using the following command:
```bash
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.
```yaml
networks:
default:
external:
name: nginx-proxy-manager
```
## Setting Up Nginx Proxy Manager
1. Install Nginx Proxy Manager on your server. You can find the installation instructions [here](https://nginxproxymanager.com/setup/).
2. Open the Nginx Proxy Manager web interface and log in with your credentials.
3. Add a new proxy host for the AdventureLog **frontend**:
- **Domain Names**: Enter the domain name where you will be hosting AdventureLog.
- **Scheme**: `http`
- **Forward Hostname/IP**: `adventurelog-frontend` The name of the AdventureLog **frontend** container in the `docker-compose.yml` file.
- **Forward Port**: `3000` This is the internal port of the AdventureLog **frontend** container so you will not need to change it even if you change the external port.
4. Add a new proxy host for the AdventureLog **backend**:
- **Domain Names**: Enter the domain name where you will be hosting AdventureLog.
- **Scheme**: `http`
- **Forward Hostname/IP**: `adventurelog-backend` The name of the AdventureLog **backend** container in the `docker-compose.yml` file.
- **Forward Port**: `80` This is the internal port of the AdventureLog **backend** container so you will not need to change it even if you change the external port.
This will allow you to access AdventureLog using the domain name you specified in the Nginx Proxy Manager configuration.

4
documentation/docs/install/proxmox_lxc.md Normal file
View file

@ -0,0 +1,4 @@
# Proxmox LXC 🐧
AdventureLog can be installed in a Proxmox LXC container. This script created by the community will help you install AdventureLog in a Proxmox LXC container.
[Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=adventurelog)

5
documentation/docs/install/synology_nas.md Normal file
View file

@ -0,0 +1,5 @@
# Installation on a Synology NAS
AdventureLog can be deployed on a Synology NAS using Docker. This guide from Marius Hosting will walk you through the process.
[Read the guide Here](https://mariushosting.com/how-to-install-adventurelog-on-your-synology-nas/)

7
documentation/docs/install/traefik.md Normal file
View file

@ -0,0 +1,7 @@
# Installation with Traefik
Traefik is a modern HTTP reverse proxy and load balancer that makes deploying microservices easy. It is designed to be simple to use and configure, and it integrates well with Docker.
AdventureLog has a built-in Traefik configuration that makes it easy to deploy and manage your AdventureLog instance.
The most recent version of the Traefik `docker-compose.yml` file can be found in the [AdventureLog GitHub repository](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose-traefik.yaml).