diff --git a/GITEA_SETUP.md b/GITEA_SETUP.md index 85b4560..89e4e48 100644 --- a/GITEA_SETUP.md +++ b/GITEA_SETUP.md @@ -86,51 +86,55 @@ To get a runner token: ### Installing Docker on the Runner (Optional) -If you want to build Docker images as part of your releases, install Docker on the runner: +Docker is **not required** for the CI/CD pipeline. Binary builds work without Docker. + +If you want to manually build Docker images: ```bash -# Install Docker -curl -fsSL https://get.docker.com -o get-docker.sh -sudo sh get-docker.sh +# Build server image +docker build -t nerd-monitor-server -f Dockerfile.server . -# Add permissions for the runner user to use Docker -sudo usermod -aG docker $USER +# Build agent image +docker build -t nerd-monitor-agent -f Dockerfile.agent . -# Verify Docker is working -docker --version - -# Note: You may need to logout and login for group permissions to take effect +# Or use docker-compose for both +docker-compose build +docker-compose up ``` -**Without Docker**: The binary builds will still work. Only Docker image generation will be skipped (the workflow will show a warning but still succeed). - ## What Happens Next Once you've set everything up: 1. **Every push to main/master** triggers the build job: - - Compiles all platform binaries - - Attempts to build Docker images (skips if Docker unavailable) - - Uploads artifacts as build artifacts + - Compiles all platform binaries (Linux, macOS, Windows) + - Creates SHA256 checksums + - Artifacts available for 30 days 2. **Every git tag push** (e.g., `v1.0.0`) triggers the full release: - Does all of the above - Creates a Gitea Release - - Uploads all binaries and checksums to the release - - Uploads Docker images if available + - Uploads all binaries and checksums to the release (permanent storage) 3. **Releases are available in**: - Repository Releases tab in Gitea - - Binaries ready for download - - Docker images (if Docker is available on runner) + - All binaries ready for download + - SHA256SUMS file for verification + +Note: Docker images are not built automatically. To build Docker images manually, use: +```bash +docker build -t nerd-monitor-server -f Dockerfile.server . +docker build -t nerd-monitor-agent -f Dockerfile.agent . +# Or use docker-compose: docker-compose build +``` ## Troubleshooting ### "docker: command not found" in workflow -- Docker is not installed on your runner -- This is **optional** - binaries will still build -- If you want Docker images, install Docker on the runner (see above) -- The workflow will gracefully skip Docker builds and show a warning +- Docker support is not required - the workflow builds binaries without it +- Binary builds will always succeed +- Docker images must be built manually using: `docker build -f Dockerfile.server .` +- See QUICKSTART.md or DOCKER_COMPOSE.md for manual Docker build instructions ### "Action not found" error - Make sure Gitea Actions is enabled