mirror of
https://github.com/seanmorley15/AdventureLog.git
synced 2025-07-18 20:39:36 +02:00
Merge branch 'development' of github.com:seanmorley15/AdventureLog into development
This commit is contained in:
commit
1ea4022e80
23 changed files with 986 additions and 169 deletions
|
@ -80,6 +80,7 @@ export default defineConfig({
|
|||
link: "/docs/install/nginx_proxy_manager",
|
||||
},
|
||||
{ text: "Traefik", link: "/docs/install/traefik" },
|
||||
{ text: "Caddy", link: "/docs/install/caddy" },
|
||||
],
|
||||
},
|
||||
],
|
||||
|
|
67
documentation/docs/install/caddy.md
Normal file
67
documentation/docs/install/caddy.md
Normal file
|
@ -0,0 +1,67 @@
|
|||
# Installation with Caddy
|
||||
|
||||
Caddy is a modern HTTP reverse proxy. It automatically integrates with Let's Encrypt (or other certificate providers) to generate TLS certificates for your site.
|
||||
|
||||
As an example, if you want to add Caddy to your Docker compose configuration, add the following service to your `docker-compose.yml`:
|
||||
|
||||
```yaml
|
||||
services:
|
||||
caddy:
|
||||
image: docker.io/library/caddy:2
|
||||
container_name: adventurelog-caddy
|
||||
restart: unless-stopped
|
||||
cap_add:
|
||||
- NET_ADMIN
|
||||
ports:
|
||||
- "80:80"
|
||||
- "443:443"
|
||||
- "443:443/udp"
|
||||
volumes:
|
||||
- ./caddy:/etc/caddy
|
||||
- caddy_data:/data
|
||||
- caddy_config:/config
|
||||
|
||||
web: ...
|
||||
server: ...
|
||||
db: ...
|
||||
|
||||
volumes:
|
||||
caddy_data:
|
||||
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:
|
||||
|
||||
```yaml
|
||||
web:
|
||||
ports:
|
||||
- "8016:80"
|
||||
…
|
||||
server:
|
||||
ports:
|
||||
- "8015:3000"
|
||||
```
|
||||
|
||||
That's it for the Docker compose changes. Of course, there are other methods to run Caddy which are equally valid.
|
||||
|
||||
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 {
|
||||
|
||||
@frontend {
|
||||
not path /media* /admin* /static* /accounts*
|
||||
}
|
||||
reverse_proxy @frontend web:3000
|
||||
|
||||
reverse_proxy server:80
|
||||
}
|
||||
```
|
||||
|
||||
Once configured, you can start up the containsers:
|
||||
|
||||
```bash
|
||||
docker compose up
|
||||
```
|
||||
|
||||
Your AdventureLog should now be up and running.
|
|
@ -33,7 +33,7 @@ Here is a summary of the configuration options available in the `docker-compose.
|
|||
| ------------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------- |
|
||||
| `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 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 **kilobytes**. | ```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 **bytes**. | ```Infinity``` |
|
||||
|
||||
### Backend Container (server)
|
||||
|
||||
|
|
|
@ -12,3 +12,4 @@ AdventureLog can be installed in a variety of ways. The following are the most c
|
|||
|
||||
- [Nginx Proxy Manager](nginx_proxy_manager.md) 🛡
|
||||
- [Traefik](traefik.md) 🚀
|
||||
- [Caddy](caddy.md) 🔒
|
||||
|
|
|
@ -4,8 +4,7 @@ When you encounter issues with the login and registration pages being unresponsi
|
|||
|
||||
1. Check to make sure the backend container is running and accessible.
|
||||
|
||||
- Check the backend container logs to see if there are any errors or issues blocking the contianer from running.
|
||||
|
||||
- Check the backend container logs to see if there are any errors or issues blocking the container from running.
|
||||
2. Check the connection between the frontend and backend containers.
|
||||
|
||||
- Attempt login with the browser console network tab open to see if there are any errors or issues with the connection between the frontend and backend containers. If there is a connection issue, the code will show an error like `Failed to load resource: net::ERR_CONNECTION_REFUSED`. If this is the case, check the `PUBLIC_SERVER_URL` in the frontend container and refer to the installation docs to ensure the correct URL is set.
|
||||
|
|
|
@ -10,7 +10,7 @@ Welcome to AdventureLog! This guide will help you get started with AdventureLog
|
|||
- **Visit**: a visit is added to an adventure. It contains a date and notes about when the adventure was visited. If an adventure is visited multiple times, multiple visits can be added. If there are no visits on an adventure or the date of all visits is in the future, the adventure is considered planned. If the date of the visit is in the past, the adventure is considered completed.
|
||||
- **Category**: a category is a way to group adventures together. For example, you could have a category for parks, a category for museums, and a category for restaurants.
|
||||
- **Tag**: a tag is a way to add additional information to an adventure. For example, you could have a tag for the type of cuisine at a restaurant or the type of art at a museum. Multiple tags can be added to an adventure.
|
||||
- **Image**: an image is a photo that is added to an adventure. Images can be added to an adventure to provide a visual representation of the location or to capture a memory of the visit. These can be uploded from your device or with a service like [Immich](/docs/configuration/immich_integration) if the integration is enabled.
|
||||
- **Image**: an image is a photo that is added to an adventure. Images can be added to an adventure to provide a visual representation of the location or to capture a memory of the visit. These can be uploaded from your device or with a service like [Immich](/docs/configuration/immich_integration) if the integration is enabled.
|
||||
- **Attachment**: an attachment is a file that is added to an adventure. Attachments can be added to an adventure to provide additional information, such as a map of the location or a brochure from the visit.
|
||||
|
||||
#### Collections
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue