Skip to content

Commit 144fa70

Browse files
author
Raffael Herrmann
committed
Simplify Docker setup instructions: download docker-compose.yml and edit volume path
1 parent 747736b commit 144fa70

1 file changed

Lines changed: 10 additions & 13 deletions

File tree

README.md

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,19 +25,19 @@ A modern web interface for browsing and searching your MassCode snippets with sy
2525

2626
### Using Docker Compose (Recommended)
2727

28-
1. **Clone the repository**:
28+
1. **Download the docker-compose.yml**:
2929
```bash
30-
git clone https://github.com/codebude/masscode-web.git
31-
cd masscode-web
30+
wget https://raw.githubusercontent.com/codebude/masscode-web/main/docker-compose.yml
3231
```
3332

34-
2. **Place your data**:
35-
```bash
36-
# Copy your MassCode db.json file to the project root
37-
cp /path/to/your/masscode/db.json ./db.json
33+
2. **Edit the volume mapping**:
34+
Open `docker-compose.yml` and update the volume path to point to your local MassCode `db.json` file:
35+
```yaml
36+
volumes:
37+
- /path/to/your/masscode/db.json:/usr/share/nginx/html/data/db.json:ro
3838
```
3939
40-
3. **Run with Docker Compose**:
40+
3. **Run the application**:
4141
```bash
4242
docker-compose up -d
4343
```
@@ -56,15 +56,12 @@ volumes:
5656
- ./db.json:/usr/share/nginx/html/data/db.json:ro
5757
```
5858
59-
This allows you to:
60-
- Keep your data file outside the container
61-
- Update snippets without rebuilding the image
62-
- Maintain data persistence
59+
**Important**: Update the left side (`./db.json`) to the actual path of your MassCode database file. The volume is read-only to prevent accidental modifications to your data.
6360

6461
### Manual Docker Run
6562

6663
```bash
67-
docker run -d -p 8080:80 -v $(pwd)/db.json:/usr/share/nginx/html/data/db.json:ro ghcr.io/codebude/masscode-web:latest
64+
docker run -d -p 8080:80 -v /path/to/your/db.json:/usr/share/nginx/html/data/db.json:ro ghcr.io/codebude/masscode-web:latest
6865
```
6966

7067
## 🎯 What is MassCode?

0 commit comments

Comments
 (0)