alex/voyage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Rename AdventureLog to Voyage and add fork attribution

Browse Source 
- Replace all AdventureLog references with Voyage across ~102 files
  (7 case variants: AdventureLog, adventurelog, Adventurelog, ADVENTURELOG,
  AdventUrelog, AdventureLOG, adventure-log, adventure_log)
- Rename brand, static, and documentation assets to use voyage naming
- Rename install_adventurelog.sh → install_voyage.sh
- Update README.md and voyage_overview.md to credit AdventureLog as
  the upstream project and Sean Morley as its original creator
This commit is contained in:
alex
2026-03-06 11:05:26 +00:00
parent 2b644d3afa
commit df8d1adf15
151 changed files with 653 additions and 658 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
documentation/docs/install/caddy.md
View File

@@ -8,7 +8,7 @@ As an example, if you want to add Caddy to your Docker compose configuration, ad
services:
caddy:
image: docker.io/library/caddy:2
container_name: adventurelog-caddy
container_name: voyage-caddy
restart: unless-stopped
cap_add:
- NET_ADMIN
@@ -30,7 +30,7 @@ volumes:
caddy_config:
```
Since all ingress traffic to the AdventureLog containsers now travels through Caddy, we can also remove the external ports configuration from those containsers in the `docker-compose.yml`. Just delete this configuration:
Since all ingress traffic to the Voyage containsers now travels through Caddy, we can also remove the external ports configuration from those containsers in the `docker-compose.yml`. Just delete this configuration:
```yaml
web:
@@ -47,7 +47,7 @@ That's it for the Docker compose changes. Of course, there are other methods to
However, we also need to configure Caddy. For this, create a file `./caddy/Caddyfile` in which you configure the requests which are proxied to the frontend and backend respectively and what domain Caddy should request a certificate for:
```
adventurelog.example.com {
voyage.example.com {
@frontend {
not path /media* /admin* /static* /accounts*
@@ -64,4 +64,4 @@ Once configured, you can start up the containsers:
docker compose up
```
Your AdventureLog should now be up and running.
Your Voyage should now be up and running.

12
documentation/docs/install/dev_container_wsl.md
View File

@@ -1,6 +1,6 @@
# Dev Container + WSL 🧰
Running AdventureLog in a **Dev Container** allows you to contribute to the project or work on features locally in a fully reproducible development environment with hot reloading, debugging, and tooling isolated inside Docker.
Running Voyage in a **Dev Container** allows you to contribute to the project or work on features locally in a fully reproducible development environment with hot reloading, debugging, and tooling isolated inside Docker.
This guide focuses on **Windows using WSL 2**, but the workflow is similar on other platforms.
@@ -53,15 +53,15 @@ Open a WSL terminal (search for "WSL" in the Windows Start menu and open the WSL
```bash
cd ~
git clone https://github.com/seanmorley15/AdventureLog.git
cd AdventureLog
git clone https://github.com/seanmorley15/Voyage.git
cd Voyage
```
> **TIP**
> If you plan to contribute changes, fork the repository on GitHub and clone your fork instead:
>
> ```bash
> git clone https://github.com/<your-username>/AdventureLog.git
> git clone https://github.com/<your-username>/Voyage.git
> ```
### 2. Create the Development `.env` File (via WSL)
@@ -159,7 +159,7 @@ Ensure:
If the project lives under `/mnt/c/...`, move it to:
```bash
/home/<user>/AdventureLog
/home/<user>/Voyage
```
This avoids performance issues and file watcher bugs.
@@ -176,5 +176,5 @@ This avoids performance issues and file watcher bugs.
For production or personal hosting, follow the standard
[**Docker 🐋 installation guide**](docker.md).
Enjoy contributing to AdventureLog! 🎉
Enjoy contributing to Voyage! 🎉
If you run into issues not covered here, please open a discussion or issue so the docs can be improved.

20
documentation/docs/install/docker.md
View File

@@ -1,6 +1,6 @@
# 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.
Docker is the preferred way to run Voyage 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.
@@ -10,26 +10,26 @@ Docker is the preferred way to run AdventureLog on your local machine. It is a l
## Getting Started
Get the `docker-compose.yml` and `.env.example` files from the AdventureLog repository. You can download them here:
Get the `docker-compose.yml` and `.env.example` files from the Voyage repository. You can download them here:
- [Docker Compose](https://github.com/seanmorley15/AdventureLog/blob/main/docker-compose.yml)
- [Environment Variables](https://github.com/seanmorley15/AdventureLog/blob/main/.env.example)
- [Docker Compose](https://github.com/seanmorley15/Voyage/blob/main/docker-compose.yml)
- [Environment Variables](https://github.com/seanmorley15/Voyage/blob/main/.env.example)
```bash
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/docker-compose.yml
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/main/.env.example
wget https://raw.githubusercontent.com/seanmorley15/Voyage/main/docker-compose.yml
wget https://raw.githubusercontent.com/seanmorley15/Voyage/main/.env.example
cp .env.example .env
```
::: tip
If running on an ARM based machine, you will need to use a different PostGIS Image. It is recommended to use the `imresamu/postgis:15-3.3-alpine3.21` image or a custom version found [here](https://hub.docker.com/r/imresamu/postgis/tags). The AdventureLog containers are ARM compatible.
If running on an ARM based machine, you will need to use a different PostGIS Image. It is recommended to use the `imresamu/postgis:15-3.3-alpine3.21` image or a custom version found [here](https://hub.docker.com/r/imresamu/postgis/tags). The Voyage containers are ARM compatible.
:::
## Configuration
The `.env` file contains all the configuration settings for your AdventureLog instance. Here’s a breakdown of each section:
The `.env` file contains all the configuration settings for your Voyage instance. Here’s a breakdown of each section:
### 🌐 Frontend (web)
@@ -73,10 +73,10 @@ The `.env` file contains all the configuration settings for your AdventureLog in
## Running the Containers
Once you've configured `.env`, you can start AdventureLog with:
Once you've configured `.env`, you can start Voyage with:
```bash
docker compose up -d
```
Enjoy using AdventureLog! 🎉
Enjoy using Voyage! 🎉

10
documentation/docs/install/getting_started.md
View File

@@ -1,12 +1,12 @@
# 🚀 Install Options for AdventureLog
# 🚀 Install Options for Voyage
AdventureLog can be installed in a variety of ways, depending on your platform or preference.
Voyage can be installed in a variety of ways, depending on your platform or preference.
## 📦 Docker Quick Start
::: tip Quick Start Script
**The fastest way to get started:**
[Install AdventureLog with a single command →](quick_start.md)
[Install Voyage with a single command →](quick_start.md)
Perfect for Docker beginners.
:::
@@ -17,8 +17,8 @@ Perfect for Docker beginners.
- [Synology NAS](synology_nas.md) — Self-host on your home NAS
- [Kubernetes + Kustomize](kustomize.md) — Advanced, scalable deployment
- [Unraid](unraid.md) — Easy integration for homelabbers
- [Umbrel](https://apps.umbrel.com/app/adventurelog) — Home server app store
- [TrueNAS](https://apps.truenas.com/catalog/adventurelog/) — TrueNAS app catalog
- [Umbrel](https://apps.umbrel.com/app/voyage) — Home server app store
- [TrueNAS](https://apps.truenas.com/catalog/voyage/) — TrueNAS app catalog
## ⚙️ Advanced & Alternative Setups

16
documentation/docs/install/kustomize.md
View File

@@ -1,16 +1,16 @@
# Kubernetes and Kustomize (k8s)
_AdventureLog can be run inside a kubernetes cluster using [kustomize](https://kustomize.io/)._
_Voyage can be run inside a kubernetes cluster using [kustomize](https://kustomize.io/)._
## Prerequisites
A working kubernetes cluster. AdventureLog has been tested on k8s, but any Kustomize-capable flavor should be easy to use.
A working kubernetes cluster. Voyage has been tested on k8s, but any Kustomize-capable flavor should be easy to use.
## Cluster Routing
Because the AdventureLog backend must be reachable by **both** the web browser and the AdventureLog frontend, k8s-internal routing mechanisms traditional for standing up other similar applications **cannot** be used.
Because the Voyage backend must be reachable by **both** the web browser and the Voyage frontend, k8s-internal routing mechanisms traditional for standing up other similar applications **cannot** be used.
In order to host AdventureLog in your cluster, you must therefor configure an internally and externally resolvable ingress that routes to your AdventureLog backend container.
In order to host Voyage in your cluster, you must therefor configure an internally and externally resolvable ingress that routes to your Voyage backend container.
Once you have made said ingress, set `PUBLIC_SERVER_URL` and `PUBLIC_URL` env variables below to the url of that ingress.
@@ -18,17 +18,17 @@ Once you have made said ingress, set `PUBLIC_SERVER_URL` and `PUBLIC_URL` env va
Many k8s homelabs choose to use [Tailscale](https://tailscale.com/) or similar projects to remove the need for open ports in your home firewall.
The [Tailscale k8s Operator](https://tailscale.com/kb/1185/kubernetes/) will set up an externally resolvable service/ingress for your AdventureLog instance,
The [Tailscale k8s Operator](https://tailscale.com/kb/1185/kubernetes/) will set up an externally resolvable service/ingress for your Voyage instance,
but it will fail to resolve internally.
You must [expose tailnet IPs to your cluster](https://tailscale.com/kb/1438/kubernetes-operator-cluster-egress#expose-a-tailnet-https-service-to-your-cluster-workloads) so the AdventureLog pods can resolve them.
You must [expose tailnet IPs to your cluster](https://tailscale.com/kb/1438/kubernetes-operator-cluster-egress#expose-a-tailnet-https-service-to-your-cluster-workloads) so the Voyage pods can resolve them.
## Getting Started
Take a look at the [example config](https://github.com/seanmorley15/AdventureLog/blob/main/kustomization.yml) and modify it for your use case.
Take a look at the [example config](https://github.com/seanmorley15/Voyage/blob/main/kustomization.yml) and modify it for your use case.
## Environment Variables
Look at the [environment variable summary](docker.md#configuration) in the docker install section to see available and required configuration options.
Enjoy AdventureLog! 🎉
Enjoy Voyage! 🎉

30
documentation/docs/install/nginx_proxy_manager.md
View File

@@ -2,26 +2,26 @@
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.
It is fairly simple to set up Nginx Proxy Manager with Voyage.
## Deploy AdventureLog using Docker
## Deploy Voyage using Docker
View the [Docker installation guide](docker.md) for instructions on how to deploy AdventureLog using Docker.
View the [Docker installation guide](docker.md) for instructions on how to deploy Voyage using Docker.
## Ensure Correct Environment Variables
- `ORIGIN` - The domain where you will be hosting AdventureLog. This is where the **frontend** will be served from.
- `ORIGIN` - The domain where you will be hosting Voyage. 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:
Ensure that the Nginx Proxy Manager and Voyage 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 following 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 Voyage service.
```yaml
networks:
@@ -34,15 +34,15 @@ networks:
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.
3. Add a new proxy host for the Voyage **frontend**:
- **Domain Names**: Enter the domain name where you will be hosting Voyage.
- **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.
- **Forward Hostname/IP**: `voyage-frontend` The name of the Voyage **frontend** container in the `docker-compose.yml` file.
- **Forward Port**: `3000` This is the internal port of the Voyage **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 Voyage **backend**:
- **Domain Names**: Enter the domain name where you will be hosting Voyage.
- **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.
- **Forward Hostname/IP**: `voyage-backend` The name of the Voyage **backend** container in the `docker-compose.yml` file.
- **Forward Port**: `80` This is the internal port of the Voyage **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.
This will allow you to access Voyage using the domain name you specified in the Nginx Proxy Manager configuration.

4
documentation/docs/install/proxmox_lxc.md
View File

@@ -1,4 +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)
Voyage can be installed in a Proxmox LXC container. This script created by the community will help you install Voyage in a Proxmox LXC container.
[Proxmox VE Helper-Scripts](https://community-scripts.github.io/ProxmoxVE/scripts?id=voyage)

10
documentation/docs/install/quick_start.md
View File

@@ -1,11 +1,11 @@
# 🚀 Quick Start Install
Install **AdventureLog** in seconds using our automated script.
Install **Voyage** in seconds using our automated script.
## 🧪 One-Liner Install
```bash
curl -sSL https://get.adventurelog.app | bash
curl -sSL https://get.voyage.app | bash
```
This will:
@@ -14,7 +14,7 @@ This will:
- Set up project directory
- Download required files
- Prompt for basic configuration (like domain name)
- Start AdventureLog with Docker Compose
- Start Voyage with Docker Compose
## ✅ Requirements
@@ -37,9 +37,9 @@ The script automatically:
To remove everything:
```bash
cd adventurelog
cd voyage
docker compose down -v
rm -rf adventurelog
rm -rf voyage
```
Need more control? Explore other [install options](getting_started.md) like Docker, Proxmox, Synology NAS, and more.

4
documentation/docs/install/synology_nas.md
View File

@@ -1,7 +1,7 @@
# 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.
Voyage 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/)
[Read the guide Here](https://mariushosting.com/how-to-install-voyage-on-your-synology-nas/)
In recent versions of Synology DSM, there might be some adjustments needed to fix Nginx should a 502 Bad Gateway Error be returned. That guide can be found [here](https://mariushosting.com/synology-nginx-reverse-proxy-how-to-fix-502-bad-gateway-error/).

4
documentation/docs/install/traefik.md
View File

@@ -2,6 +2,6 @@
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.
Voyage has a built-in Traefik configuration that makes it easy to deploy and manage your Voyage 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).
The most recent version of the Traefik `docker-compose.yml` file can be found in the [Voyage GitHub repository](https://github.com/seanmorley15/Voyage/blob/main/docker-compose-traefik.yaml).

8
documentation/docs/install/unraid.md
View File

@@ -1,8 +1,8 @@
# 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`.
Voyage is available in the Unraid Community Applications store. You can install it by searching for `Voyage` 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 Voyage: [Voyage on CA Store](https://unraid.net/community/apps?q=Voyage)\
Community Applications Page for PostGIS: [PostGIS on CA Store](https://unraid.net/community/apps?q=PostGIS)
## Installation Configuration
@@ -18,7 +18,7 @@ docker network create example
## Database
- 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
- There is **no** Voyage---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`
- 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.
@@ -72,6 +72,6 @@ docker network create example
## Additional Resources
Youtuber AlienTech42 has created a helpful video walking through the installation of AdventureLog on Unraid:
Youtuber AlienTech42 has created a helpful video walking through the installation of Voyage on Unraid:
<iframe width="560" height="315" src="https://www.youtube.com/embed/hJnoePdAhXg" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>