Skip to content

Commit e8a6b8e

Browse files
committed
Docs: update README with Docker Compose instructions and SSL certificate notes
1 parent cbfd8d1 commit e8a6b8e

File tree

1 file changed

+38
-1
lines changed

1 file changed

+38
-1
lines changed

README.md

Lines changed: 38 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,44 @@ Advanced users can mount their own certificate (the config expects 3 files: `/ce
4141

4242
### Docker
4343

44-
The docker image can be built with the following command:
44+
#### Starting Siren with Docker Compose
45+
46+
1. Copy the environment file:
47+
```bash
48+
cp .env.example .env
49+
```
50+
51+
2. Edit `.env` with your configuration (at minimum set `BEACON_URL`, `VALIDATOR_URL`, and `API_TOKEN`)
52+
53+
3. Start the services:
54+
```bash
55+
docker compose up -d
56+
```
57+
The `-d` flag runs the containers in the background. Remove it if you want to see the logs directly in your terminal.
58+
59+
4. Access Siren at https://localhost:4443
60+
61+
Note: When you first visit the site, your browser will show a security warning because Siren uses a self-signed SSL certificate. This is expected and safe for local development. You can proceed by:
62+
- In Chrome: Click "Advanced" and then "Proceed to localhost (unsafe)"
63+
- In Firefox: Click "Advanced..." and then "Accept the Risk and Continue"
64+
- In Safari: Click "Show Details" and then "visit this website"
65+
66+
#### Stopping Siren
67+
68+
To stop the services:
69+
```bash
70+
docker compose down
71+
```
72+
73+
To stop and remove all data (including certificates):
74+
```bash
75+
docker compose down -v
76+
```
77+
78+
#### Alternative Docker Run Method
79+
80+
You can also run Siren using the docker run command:
81+
4582
`docker build -f Dockerfile -t siren .`
4683

4784
### Building locally

0 commit comments

Comments
 (0)