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:
Sean Morley
parent
8e5a20ec62
commit
17d8784d8c
59 changed files with 1967 additions and 11276 deletions
|
|
@ -1,8 +0,0 @@
|
|||
{
|
||||
"label": "Configuration ⚙️",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Options for AdventureLog settings."
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
|
|
@ -1,8 +0,0 @@
|
|||
{
|
||||
"label": "Guides 📚",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Guides for AdventureLog."
|
||||
}
|
||||
}
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
{
|
||||
"label": "Installation 🖥️",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "How to get AdventureLog installed and setup."
|
||||
}
|
||||
}
|
||||
|
|
@ -1,76 +0,0 @@
|
|||
# Terms and Privacy Policy
|
||||
|
||||
**This document only applies to the demo version of AdventureLog hosted on adventurelog.app. If you are using a self-hosted version of AdventureLog, you are responsible for creating and maintaining your own terms and privacy policy and the terms of the GPL-3.0 license apply.**
|
||||
|
||||
### Terms and Conditions for AdventureLog
|
||||
|
||||
#### 1. **Introduction**
|
||||
|
||||
Welcome to AdventureLog ("App"). By using this App, you agree to comply with and be bound by the following terms and conditions ("Terms"). Please review these Terms carefully before using the App. If you do not agree with these Terms, you should not use the App.
|
||||
|
||||
#### 2. **License**
|
||||
|
||||
This App is provided as open-source software under the GPL-3.0 license. By using this App, you acknowledge that the App is provided on an "AS IS" basis without warranties of any kind, either express or implied. The demo version of the App is offered for testing and development purposes only.
|
||||
|
||||
#### 3. **No Warranty**
|
||||
|
||||
The App, including the demo version, is provided "as is" without any representations or warranties, express or implied. The use of the App is at your own risk. We do not warrant that the App will be error-free or that access to the App will be uninterrupted.
|
||||
|
||||
#### 4. **Limitation of Liability**
|
||||
|
||||
To the fullest extent permitted by law, AdventureLog and its developers shall not be liable for any indirect, incidental, special, consequential, or punitive damages, or any loss of data, use, or profit, arising out of or in connection with your use of or inability to use the App. This includes, but is not limited to, any damage to your device, data, or other materials.
|
||||
|
||||
#### 5. **User Responsibility**
|
||||
|
||||
You are solely responsible for the use of the App and any consequences thereof. The App is provided for educational and testing purposes in its demo form. You agree to use the App responsibly and in compliance with all applicable laws.
|
||||
|
||||
#### 6. **Modifications to the Terms**
|
||||
|
||||
We reserve the right to modify these Terms at any time. Any changes will be posted to this page, and your continued use of the App following such changes constitutes acceptance of the new Terms.
|
||||
|
||||
#### 7. **Termination**
|
||||
|
||||
We may terminate or suspend access to the App immediately, without prior notice or liability, for any reason whatsoever, including but not limited to a breach of the Terms.
|
||||
|
||||
#### 8. **Governing Law**
|
||||
|
||||
These Terms shall be governed by and construed in accordance with the laws of the United States of America. Any disputes arising from these Terms shall be subject to the exclusive jurisdiction of the courts in the United States.
|
||||
|
||||
---
|
||||
|
||||
### Privacy Policy for AdventureLog
|
||||
|
||||
#### 1. **Introduction**
|
||||
|
||||
This Privacy Policy outlines how AdventureLog ("we," "us," or "our") collects, uses, and protects any information that you provide when using the demo version of the AdventureLog ("App").
|
||||
|
||||
#### 2. **Information We Collect**
|
||||
|
||||
- User profile information: We may collect your name, email address, and other information you provide when creating an account. This information is used to identify you as a user of the App.
|
||||
- Adventure data: We collect data related to your adventures, including locations, photos, and notes. This is essential for the functionality of the App.
|
||||
|
||||
**Bottom line**: _We collect only the information necessary to provide the services of the App and do not share it with third parties._
|
||||
|
||||
#### 3. **Use of Collected Information**
|
||||
|
||||
Any technical information collected will be used solely for the purpose of improving the App and ensuring its functionality. We do not sell, rent, or lease your data to third parties.
|
||||
|
||||
#### 4. **Data Security**
|
||||
|
||||
We are committed to ensuring that your information is secure. However, please be aware that no method of transmission over the internet, or method of electronic storage, is 100% secure, and we cannot guarantee the absolute security of your data.
|
||||
|
||||
#### 5. **Third-Party Services**
|
||||
|
||||
The demo version of the App may include third-party services or links to external sites. We are not responsible for the privacy practices or content of these third-party services. Please review their privacy policies before using their services.
|
||||
|
||||
#### 6. **Children's Privacy**
|
||||
|
||||
The App is not intended for use by anyone under the age of 13, and we do not knowingly collect personal data from children.
|
||||
|
||||
#### 7. **Changes to This Privacy Policy**
|
||||
|
||||
We reserve the right to update this Privacy Policy at any time. Any changes will be posted on this page, and your continued use of the App following such changes constitutes acceptance of the new Privacy Policy.
|
||||
|
||||
#### 8. **Contact Us**
|
||||
|
||||
If you have any questions about this Privacy Policy, please contact us at contact@adventurelog.app
|
||||
|
|
@ -1,8 +0,0 @@
|
|||
{
|
||||
"label": "Usage ✈️",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "How to use AdventureLog."
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
50
documentation/docs/changelogs/v0-7-0.md
Normal file
50
documentation/docs/changelogs/v0-7-0.md
Normal file
|
|
@ -0,0 +1,50 @@
|
|||
# AdventureLog v0.7.0
|
||||
|
||||
Released 10-15-2024
|
||||
|
||||
Hi everyone! I am super excited to announce AdventureLog v0.7.0! This is one of the biggest updates I have ever released and I am super happy its finally ready for all of you to enjoy. The majority of this update is based around community feedback and ideas which is awesome!
|
||||
|
||||
# What's New
|
||||
|
||||
### Adventures 📍
|
||||
|
||||
- Adventures can now be visited multiple times by adding a new visit.
|
||||
- Existing adventure dates will be automatically migrated to this new format
|
||||
- Adventures now use categories for organization.
|
||||
- A new adventure creation/edit modal simplifies the process and has a cleaner overall design with dropdown menus.
|
||||
|
||||
### Collections 🍱
|
||||
|
||||
- **Collections can now be shared with other public users for collaboration!**
|
||||
- Collections now have a link field so you can attach things like photo albums right to your collection.
|
||||
|
||||
### World Travel 🗺️
|
||||
|
||||
- The World Travel dataset now includes **every ISO defined country and region**. It is based off of a new dataset [dr5hn/countries-states-cities-database](https://github.com/dr5hn/countries-states-cities-database). Searching for countries is now supported. Capitals and world regions are now listed on the country card.
|
||||
|
||||
### Profiles 👥
|
||||
|
||||
- Users can now toggle their profile to be public. This allows other users to share collections with them for collaboration.
|
||||
|
||||
### Bug Fixes 🐛
|
||||
|
||||
- Fixed bug where collection dates during daylight savings time would cause errors in date placement
|
||||
- Fixed login issue with usernames of different cases
|
||||
|
||||
### Other
|
||||
|
||||
- New logo for AdventureLog! Thanks @redtechtiger!
|
||||
- Releases now include a multi-arch image like pushes to main
|
||||
- Docker compose file now has more comments for clarity
|
||||
- New Aesthetic Dark theme (its my favorite by far)
|
||||
|
||||
# Sponsorship 💖
|
||||
|
||||
[](https://www.buymeacoffee.com/seanmorley15)
|
||||
As a computer science student, I pour my free time into developing and enhancing AdventureLog, driven by my passion for this project and its potential to make adventure planning easier for everyone. Your support, no matter the amount, means the world to me. It shows that you believe in the project and its future. I’m excited to announce that I’ve launched my page on Buy Me A Coffee—check it out!
|
||||
|
||||
Hope you all enjoy!
|
||||
Feel free to join the release discussion below to share feedback and ideas or anything else related to this update!
|
||||
|
||||
Happy travels,
|
||||
Sean @seanmorley15
|
||||
59
documentation/docs/changelogs/v0-7-1.md
Normal file
59
documentation/docs/changelogs/v0-7-1.md
Normal file
|
|
@ -0,0 +1,59 @@
|
|||
# AdventureLog v0.7.1
|
||||
|
||||
Released 11-13-2024
|
||||
|
||||
Hi everyone! I am super excited to announce the release of AdventureLog v0.7.1. This update includes a lot of improvements that make using AdventureLog more enjoyable and accessible. This update is largely community driven as it addresses more than 10 enhancement requests (thanks everyone!).
|
||||
|
||||
# What's New ✨
|
||||
|
||||
### Docker Compose Change 🐋
|
||||
|
||||
> [!IMPORTANT]
|
||||
> _While the app will still function normally without these changes_, they are recommended for the best support and stability
|
||||
> The **migration guide** can be found here: https://docs.adventurelog.app/docs/Guides/nginx_migration
|
||||
|
||||
- Migrated nginx inside of server container for easier deployment, removed external nginx requirement
|
||||
- App now uses gunicorn for better performance at scale
|
||||
|
||||
### Adventures 📍
|
||||
|
||||
- Adventures can now be sorted by visit status (visited or planned) on the adventures screen.
|
||||
- The Adventure create/edit modal now supports reverse geocoding locations. This means that for most places, the location field will be auto filled when you click on the map. It now has a popup of the associated world travel region and allows you to mark the region as visited if its not already. This makes it easier to track your world region visits!
|
||||
- The adventure map now shows previews of images and has the emoji of the category on the map pin!
|
||||
- In settings, you can perform a visited region check. This will scan all of your visited adventures and mark the associated world travel region as visited if its detected in the adventure. This serves as a bulk operation for for existing adventures.
|
||||
|
||||
### World Travel 🗺️
|
||||
|
||||
- World travel regions can now be sorted by world regions and visit status. The statuses are fully visited, partially visited, and not visited.
|
||||
|
||||
### Bug Fixes 🐛
|
||||
|
||||
- Fixed a bug where sorting by date would return to home screen
|
||||
|
||||
### Localization 🌐
|
||||
|
||||
- Migrated app to a localization framework
|
||||
- Added toggle for languages on the `...` menu in the top right.
|
||||
- **Supported Languages**: English, Spanish, French, German, Italian, Chinese, Dutch, Swedish
|
||||
|
||||
### Other
|
||||
|
||||
- New login and signup screen featuring adventures from community members (submitted in discord server).
|
||||
|
||||
## What's Next ⏭️
|
||||
|
||||
- Custom categories for adventures
|
||||
- Ability to link adventures to multiple collections
|
||||
- MFA and ODIC auth
|
||||
- Immich integration
|
||||
|
||||
# Sponsorship 💖
|
||||
|
||||
[](https://www.buymeacoffee.com/seanmorley15)
|
||||
As a computer science student, I pour my free time into developing and enhancing AdventureLog, driven by my passion for this project and its potential to make adventure planning easier for everyone. Your support, no matter the amount, means the world to me. It shows that you believe in the project and its future. I’m excited to announce that I’ve launched my page on Buy Me A Coffee—check it out!
|
||||
|
||||
Hope you all enjoy!
|
||||
Feel free to join the release discussion below to share feedback and ideas or anything else related to this update!
|
||||
|
||||
Happy travels,
|
||||
Sean @seanmorley15
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# 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/).
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Disable Registration
|
||||
|
||||
To disable registration, you can set the following variable in your docker-compose.yml under the server service:
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Change Email Backend
|
||||
|
||||
To change the email backend, you can set the following variable in your docker-compose.yml under the server service:
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# 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!
|
||||
|
|
@ -1,14 +1,10 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# 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.
|
||||
|
||||
## Docker Compose Changes
|
||||
|
||||
:::note
|
||||
::: tip
|
||||
|
||||
You can also just use the new `docker-compose.yml` file in the repository and change the environment variables to match your setup.
|
||||
|
||||
|
|
@ -17,15 +13,19 @@ You can also just use the new `docker-compose.yml` file in the repository and ch
|
|||
1. Remove the `nginx` service from your `docker-compose.yml` file.
|
||||
2. Update the `PUBLIC_URL` environment variable in the `server` service (backend) to match the address of your **server**, instead of the previous nginx instance. For example, if your server is exposed to `http://localhost:8000`, set `PUBLIC_URL` to `http://localhost:8000`. If you are using a domain name, set `PUBLIC_URL` to `https://api.yourdomain.com` as an example.
|
||||
3. Change port mapping for the `server` service. Right now it probably looks like this:
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
- "your-exposed-port:8000"
|
||||
```
|
||||
|
||||
Change it to:
|
||||
|
||||
```yaml
|
||||
ports:
|
||||
- "your-exposed-port:80"
|
||||
```
|
||||
|
||||
This is because the nginx instance in the container is now serving the Django application on port 80. The port on the left side of the colon is the port on your host machine and this can be changed to whatever you want. The port on the right side of the colon is the port the Django application is running on in the container and should not be changed.
|
||||
|
||||
That's it! You should now be able to run the application with the new configuration! This update also includes some performance enhancements so there should be a slight speed increase as well, especially with multiple users.
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# 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.
|
||||
12
documentation/docs/install/getting_started.md
Normal file
12
documentation/docs/install/getting_started.md
Normal 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
48
documentation/docs/install/nginx_proxy_manager.md
Normal 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.
|
||||
|
|
@ -1,7 +1,3 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# 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.
|
||||
5
documentation/docs/install/synology_nas.md
Normal file
5
documentation/docs/install/synology_nas.md
Normal 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
7
documentation/docs/install/traefik.md
Normal 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).
|
||||
|
|
@ -1,9 +0,0 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Intro 1️⃣
|
||||
|
||||
This tutorial will guide you how to get AdventureLog up and running on your local machine quickly and easily.
|
||||
|
||||
Click next below to get started:
|
||||
30
documentation/docs/intro/adventurelog_overview.md
Normal file
30
documentation/docs/intro/adventurelog_overview.md
Normal file
|
|
@ -0,0 +1,30 @@
|
|||
# About AdventureLog
|
||||
|
||||
Starting from a simple idea of tracking travel locations (called adventures), AdventureLog has grown into a full-fledged travel companion. With AdventureLog, you can log your adventures, keep track of where you've been on the world map, plan your next trip collaboratively, and share your experiences with friends and family. **AdventureLog is the ultimate travel companion for the modern-day explorer**.
|
||||
|
||||
## Features
|
||||
|
||||
- **Track Your Adventures** 🌍: Log your adventures and keep track of where you've been on the world map.
|
||||
- Adventures can store a variety of information, including the location, date, and description.
|
||||
- Adventures can be sorted into custom categories for easy organization.
|
||||
- Adventures can be marked as private or public, allowing you to share your adventures with friends and family.
|
||||
- Keep track of the countries and regions you've visited with the world travel book.
|
||||
- **Plan Your Next Trip** 📃: Take the guesswork out of planning your next adventure with an easy-to-use itinerary planner.
|
||||
- Itineraries can be created for any number of days and can include multiple destinations.
|
||||
- Itineraries include many planning features like flight information, notes, checklists, and links to external resources.
|
||||
- Itineraries can be shared with friends and family for collaborative planning.
|
||||
- **Share Your Experiences** 📸: Share your adventures with friends and family and collaborate on trips together.
|
||||
- Adventures and itineraries can be shared via a public link or directly with other AdventureLog users.
|
||||
- Collaborators can view and edit shared itineraries (collections), making planning a breeze.
|
||||
|
||||
## Why AdventureLog?
|
||||
|
||||
AdventureLog was created to solve a problem: the lack of a modern, open-source, user-friendly travel companion. Many existing travel apps are either too complex, too expensive, or too closed-off to be useful for the average traveler. AdventureLog aims to be the opposite: simple, beautiful, and open to everyone.
|
||||
|
||||
### Open Source (GPL-3.0)
|
||||
|
||||
AdventureLog is open-source software, licensed under the GPL-3.0 license. This means that you are free to use, modify, and distribute AdventureLog as you see fit. The source code is available on GitHub, and contributions are welcome from anyone who wants to help improve the project.
|
||||
|
||||
## About the Maintainer
|
||||
|
||||
AdventureLog is created and maintined by [Sean Morley](https://seanmorley.com), a Computer Science student at the University of Connecticut. Sean is passionate about open-source software and building modern tools that help people solve real-world problems.
|
||||
41
documentation/docs/troubleshooting/nginx_failed.md
Normal file
41
documentation/docs/troubleshooting/nginx_failed.md
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
# Troubleshooting: `Starting nginx: nginx failed!` in the Backend Container
|
||||
|
||||
The AdventureLog backend container uses a built-in Nginx container with a built-in nginx config that relies on the name `server` to be the service name of the backend container. If the Nginx service fails to start in the backend container, the whole backend service will keep restarting and fail to start.
|
||||
|
||||
**The primary reason for this error is changing the backend service name `server` to something different**
|
||||
|
||||
If you're experiencing issues with the Nginx service failing to start in the backend container, follow these troubleshooting steps to resolve the issue.
|
||||
|
||||
### 1. **Check the `server` Service Name**:
|
||||
|
||||
- Verify that the service name of the backend container is set to `server` in the `docker-compose.yml` file.
|
||||
- The service name should be set to `server` in the `docker-compose.yml` file. For example:
|
||||
```yaml
|
||||
server:
|
||||
image: ghcr.io/seanmorley15/adventurelog-backend:latest
|
||||
container_name: adventurelog-backend
|
||||
```
|
||||
|
||||
### 2. **To keep the backend service name different**:
|
||||
|
||||
- If you want to keep the backend service name different from `server`, you can mount a custom Nginx configuration file to the backend container.
|
||||
|
||||
- Get the default Nginx configuration file from the AdventureLog repository:
|
||||
|
||||
```bash
|
||||
wget https://raw.githubusercontent.com/seanmorley15/AdventureLog/refs/heads/main/backend/nginx.conf
|
||||
```
|
||||
|
||||
- Update the `nginx.conf` file to replace all occurrences of `server` with your custom service name.
|
||||
- Mount the custom Nginx configuration file to the backend container in the `docker-compose.yml` file. For example:
|
||||
```yaml
|
||||
server:
|
||||
image: ghcr.io/seanmorley15/adventurelog-backend:latest
|
||||
container_name: adventurelog-backend
|
||||
volumes:
|
||||
- ./nginx.conf:/etc/nginx/nginx.conf
|
||||
```
|
||||
|
||||
### 3. **Restart the Backend Container**:
|
||||
|
||||
These steps should help you resolve the issue with the Nginx service failing to start in the backend container. If you continue to face issues, please reach out to the AdventureLog community on Discord or GitHub for further assistance.
|
||||
20
documentation/docs/troubleshooting/no_images.md
Normal file
20
documentation/docs/troubleshooting/no_images.md
Normal file
|
|
@ -0,0 +1,20 @@
|
|||
# Troubleshooting: Images Not Displayed in AdventureLog
|
||||
|
||||
The AdventureLog backend container uses a built-in Nginx container to serve media to the frontend. The `PUBLIC_URL` environment variable is set to the external URL of the **backend** container. This URL is used to generate the URLs for the images in the frontend. If this URL is not set correctly or not accessible from the frontend, the images will not be displayed.
|
||||
|
||||
If you're experiencing issues with images not displaying in AdventureLog, follow these troubleshooting steps to resolve the issue.
|
||||
|
||||
1. **Check the `PUBLIC_URL` Environment Variable**:
|
||||
|
||||
- Verify that the `PUBLIC_URL` environment variable is set correctly in the `docker-compose.yml` file for the `server` service.
|
||||
- The `PUBLIC_URL` should be set to the external URL of the backend container. For example:
|
||||
```
|
||||
PUBLIC_URL=http://backend.example.com
|
||||
```
|
||||
|
||||
2. **Check `CSRF_TRUSTED_ORIGINS` Environment Variable**:
|
||||
- If you have set the `CSRF_TRUSTED_ORIGINS` environment variable in the `docker-compose.yml` file, ensure that it includes the frontend URL and the backend URL.
|
||||
- For example:
|
||||
```
|
||||
CSRF_TRUSTED_ORIGINS=http://frontend.example.com,http://backend.example.com
|
||||
```
|
||||
Loading…
Add table
Add a link
Reference in a new issue