Skip to content

Commit 020a81e

Browse files
committed
chore: add deploy example
1 parent c0f8f9c commit 020a81e

File tree

4 files changed

+79
-0
lines changed

4 files changed

+79
-0
lines changed

deploy/docker-compose/Caddyfile

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
localhost:80, http://goblin.run, https://goblin.run {
2+
reverse_proxy goblin:3000
3+
}

deploy/docker-compose/README.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# docker-compose-setup
2+
3+
The example setup is for running an instance of goblin on your personal server
4+
using Docker + Docker Compose and Caddy.
5+
6+
The Setup process involves a few simple steps.
7+
8+
1. Create a Caddy Network bridge
9+
10+
```sh
11+
; docker network create -d bridge caddy_network
12+
```
13+
14+
> [!NOTE]: Replace `caddy_network` with something else if you already have a
15+
> similar name for a different cluster and would like to avoid merging the
16+
> existing caddy services with this one. If merging them is not an issue, please
17+
> continue with the exiting name.
18+
19+
2. Modify the `Caddyfile` to make sure it has the right domains, the example has
20+
`goblin.run`.
21+
3. Run the Caddy Service, you only need to run this once and just verify it's
22+
running by using `docker compose ps`
23+
24+
```sh
25+
docker compose -f ./docker-compose.yml up -d
26+
```
27+
28+
4. Now you can run the `goblin` service using the following
29+
30+
```sh
31+
docker compose -f ./docker-compose.goblin.yml up -d
32+
```
33+
34+
You can verify the status of the running containers by running the following
35+
36+
```sh
37+
docker compose ps
38+
```
39+
40+
You should have the services `caddy-1` and `goblin-1` running and will manage
41+
the domain mapping for you.
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: "3"
2+
3+
services:
4+
goblin:
5+
image: ghcr.io/barelyhuman/goblin:nightly
6+
platform: "linux/amd64"
7+
networks:
8+
- caddy_network
9+
ports:
10+
- 3000:3000
11+
12+
networks:
13+
caddy_network:
14+
external: true
Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
version: "3"
2+
3+
services:
4+
caddy:
5+
image: caddy:2
6+
restart: unless-stopped
7+
ports:
8+
- '80:80'
9+
- '443:443'
10+
networks:
11+
- caddy_network
12+
volumes:
13+
- caddy:/data
14+
- ./Caddyfile:/etc/caddy/Caddyfile
15+
16+
volumes:
17+
caddy:
18+
19+
networks:
20+
caddy_network:
21+
external: true

0 commit comments

Comments
 (0)