Skip to content

Commit f2427c5

Browse files
committed
docs: add RELEASE.md with installation and usage instructions
1 parent c321c7d commit f2427c5

File tree

1 file changed

+50
-0
lines changed

1 file changed

+50
-0
lines changed

RELEASE.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
# gorun v0.1.0
2+
3+
A Go HTTP server that provides a simple interface to run tool-spec containers.
4+
5+
## Prerequisites
6+
7+
- Docker installed and running
8+
- Access to Docker daemon (via socket or TCP)
9+
10+
## Quick Start
11+
12+
1. Download the appropriate binary for your platform
13+
2. Make it executable (Linux/macOS):
14+
```bash
15+
chmod +x gorun
16+
```
17+
3. Run the server:
18+
```bash
19+
./gorun serve
20+
```
21+
22+
## Docker Deployment
23+
24+
For production use, we recommend running gorun in a Docker container:
25+
26+
```bash
27+
docker run -d \
28+
-p 8080:8080 \
29+
-v /path/to/local/data:/data/gorun \
30+
-v /var/run/docker.sock:/var/run/docker.sock \
31+
-e GORUN_PORT=8080 \
32+
-e GORUN_SECRET=your-secret-here \
33+
-e GORUN_MOUNT_PATH=/data/gorun/mounts \
34+
-e GORUN_DB=/data/gorun/gorun.db \
35+
--name gorun \
36+
hydrocode-de/gorun:latest
37+
```
38+
39+
## Environment Variables
40+
41+
- `GORUN_PORT` (Optional, default: 8080)
42+
- Port for the web interface
43+
- `GORUN_SECRET` (Required)
44+
- Secret key for authentication
45+
- `GORUN_MOUNT_PATH` (Optional)
46+
- Directory for container mounts
47+
- `GORUN_DB` (Optional)
48+
- Path to the SQLite database
49+
- `GORUN_PATH` (Optional)
50+
- Base directory for all gorun data

0 commit comments

Comments
 (0)