Skip to content

Commit 7c51918

Browse files
committed
Update docs
1 parent eeb495e commit 7c51918

File tree

2 files changed

+110
-2
lines changed

2 files changed

+110
-2
lines changed

README.md

Lines changed: 52 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,58 @@ While it is possible to configure a custom database and compile SEOnaut manually
1717

1818
### Quick Start Guide
1919

20-
To get started with SEOnaut, follow these steps to run it using Docker:
20+
#### Using docker compose
21+
22+
Using docker is the recommended way of running SEOnaut. As you need to provide a database, you can use `docker compose` to do so creating a `docker-compose.yml` file like this:
23+
24+
```yml
25+
services:
26+
db:
27+
image: mysql:8.4
28+
container_name: "SEOnaut-db"
29+
environment:
30+
- MYSQL_ROOT_PASSWORD=root
31+
- MYSQL_DATABASE=seonaut
32+
- MYSQL_USER=seonaut
33+
- MYSQL_PASSWORD=seonaut
34+
networks:
35+
- seonaut_network
36+
37+
app:
38+
image: ghcr.io/stjudewashere/seonaut:latest
39+
container_name: "SEOnaut-app"
40+
ports:
41+
- "${SEONAUT_PORT:-9000}:9000"
42+
depends_on:
43+
- db
44+
command: sh -c "/bin/wait && /app/seonaut"
45+
environment:
46+
- WAIT_HOSTS=db:3306
47+
- WAIT_TIMEOUT=300
48+
- WAIT_SLEEP_INTERVAL=30
49+
- WAIT_HOST_CONNECT_TIMEOUT=30
50+
# Seonaut config overrides
51+
# - SEONAUT_SERVER_HOST=${SEONAUT_SERVER_HOST:-0.0.0.0}
52+
# - SEONAUT_SERVER_PORT=${SEONAUT_INTERNAL_PORT:-9000}
53+
# - SEONAUT_SERVER_URL=${SEONAUT_SERVER_URL:-http://localhost:${SEONAUT_PORT:-9000}}
54+
# - SEONAUT_DATABASE_SERVER=${SEONAUT_DB_SERVER:-db}
55+
# - SEONAUT_DATABASE_PORT=${SEONAUT_DB_PORT:-3306}
56+
# - SEONAUT_DATABASE_USER=${SEONAUT_DB_USER:-seonaut}
57+
# - SEONAUT_DATABASE_PASSWORD=${SEONAUT_DB_PASSWORD:-seonaut}
58+
# - SEONAUT_DATABASE_DATABASE=${SEONAUT_DB_NAME:-seonaut}
59+
networks:
60+
- seonaut_network
61+
62+
networks:
63+
seonaut_network:
64+
driver: bridge
65+
```
66+
67+
This uses the default settings, which you can overwrite using environment variables if needed.
68+
69+
#### Using docker from source code
70+
71+
To run SEOnaut from source code, follow these steps to run it using Docker:
2172
2273
1. **Install Docker**
2374
Ensure Docker is installed on your system. You can download and install Docker from the [official website](https://www.docker.com/).

docs/INSTALL.md

Lines changed: 58 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,64 @@ Before installing SEOnaut, ensure the following are installed on your system:
1717

1818
## Installation Options
1919

20-
### Using Docker
20+
### Using docker compose
21+
22+
Using docker is the recommended way of running SEOnaut. As you need to provide a database, you can use `docker compose` to do so creating a `docker-compose.yml` file like this:
23+
24+
```yml
25+
services:
26+
db:
27+
image: mysql:8.4
28+
container_name: "SEOnaut-db"
29+
environment:
30+
- MYSQL_ROOT_PASSWORD=root
31+
- MYSQL_DATABASE=seonaut
32+
- MYSQL_USER=seonaut
33+
- MYSQL_PASSWORD=seonaut
34+
networks:
35+
- seonaut_network
36+
37+
app:
38+
image: ghcr.io/stjudewashere/seonaut:latest
39+
container_name: "SEOnaut-app"
40+
ports:
41+
- "${SEONAUT_PORT:-9000}:9000"
42+
depends_on:
43+
- db
44+
command: sh -c "/bin/wait && /app/seonaut"
45+
environment:
46+
- WAIT_HOSTS=db:3306
47+
- WAIT_TIMEOUT=300
48+
- WAIT_SLEEP_INTERVAL=30
49+
- WAIT_HOST_CONNECT_TIMEOUT=30
50+
# Seonaut config overrides
51+
# - SEONAUT_SERVER_HOST=${SEONAUT_SERVER_HOST:-0.0.0.0}
52+
# - SEONAUT_SERVER_PORT=${SEONAUT_INTERNAL_PORT:-9000}
53+
# - SEONAUT_SERVER_URL=${SEONAUT_SERVER_URL:-http://localhost:${SEONAUT_PORT:-9000}}
54+
# - SEONAUT_DATABASE_SERVER=${SEONAUT_DB_SERVER:-db}
55+
# - SEONAUT_DATABASE_PORT=${SEONAUT_DB_PORT:-3306}
56+
# - SEONAUT_DATABASE_USER=${SEONAUT_DB_USER:-seonaut}
57+
# - SEONAUT_DATABASE_PASSWORD=${SEONAUT_DB_PASSWORD:-seonaut}
58+
# - SEONAUT_DATABASE_DATABASE=${SEONAUT_DB_NAME:-seonaut}
59+
networks:
60+
- seonaut_network
61+
62+
networks:
63+
seonaut_network:
64+
driver: bridge
65+
```
66+
67+
This will pull the latest SEOnaut image and run it with the default settings. You can overwrite the default settings using environment variables if needed.
68+
69+
### Getting latest docker image
70+
71+
In case you want to pull the latest image to use it in a different setting, you can pull it from the registry:
72+
73+
```sh
74+
$ docker pull ghcr.io/stjudewashere/seonaut:latest
75+
```
76+
77+
### Using docker from source code
2178

2279
1. **Clone the Repository**
2380
Clone the SEOnaut repository from GitHub:

0 commit comments

Comments
 (0)