add docker stuff
Marco Andronaco andronacomarco@gmail.com
Fri, 22 Dec 2023 13:23:14 +0100
5 files changed,
112 insertions(+),
2 deletions(-)
A
.github/workflows/publish.yaml
@@ -0,0 +1,48 @@
+# +name: Create and publish a Docker image + +# Configures this workflow to run every time a change is pushed to the branch called `main`. +on: + push: + branches: ['main'] + +# Defines two custom environment variables for the workflow. These are used for the Container registry domain, and a name for the Docker image that this workflow builds. +env: + REGISTRY: ghcr.io + IMAGE_NAME: ${{ github.repository }} + +# There is a single job in this workflow. It's configured to run on the latest available version of Ubuntu. +jobs: + build-and-push-image: + runs-on: ubuntu-latest + # Sets the permissions granted to the `GITHUB_TOKEN` for the actions in this job. + permissions: + contents: read + packages: write + # + steps: + - name: Checkout repository + uses: actions/checkout@v3 + # Uses the `docker/login-action` action to log in to the Container registry registry using the account and password that will publish the packages. Once published, the packages are scoped to the account defined here. + - name: Log in to the Container registry + uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1 + with: + registry: ${{ env.REGISTRY }} + username: ${{ github.actor }} + password: ${{ secrets.GITHUB_TOKEN }} + # This step uses [docker/metadata-action](https://github.com/docker/metadata-action#about) to extract tags and labels that will be applied to the specified image. The `id` "meta" allows the output of this step to be referenced in a subsequent step. The `images` value provides the base name for the tags and labels. + - name: Extract metadata (tags, labels) for Docker + id: meta + uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7 + with: + images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} + # This step uses the `docker/build-push-action` action to build the image, based on your repository's `Dockerfile`. If the build succeeds, it pushes the image to GitHub Packages. + # It uses the `context` parameter to define the build's context as the set of files located in the specified path. For more information, see "[Usage](https://github.com/docker/build-push-action#usage)" in the README of the `docker/build-push-action` repository. + # It uses the `tags` and `labels` parameters to tag and label the image with the output from the "meta" step. + - name: Build and push Docker image + uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4 + with: + context: . + push: true + tags: ${{ steps.meta.outputs.tags }} + labels: ${{ steps.meta.outputs.labels }}
A
Dockerfile
@@ -0,0 +1,33 @@
+# syntax=docker/dockerfile:1 + +FROM golang:alpine AS builder + +WORKDIR /build + +# Download Go modules +COPY go.mod go.sum ./ +RUN go mod download + +# Transfer source code +COPY templates ./templates +COPY static ./static +COPY cache ./cache +COPY *.go ./ + +# Build +RUN CGO_ENABLED=0 go build -trimpath -o /dist/app +COPY templates /dist/templates +COPY static /dist/static + +# Test +FROM build-stage AS run-test-stage +RUN go test -v ./... + +FROM scratch AS build-release-stage + +COPY --from=builder /etc/ssl/certs/ca-certificates.crt /etc/ssl/certs/ +COPY --from=builder /dist /app + +WORKDIR /app + +ENTRYPOINT ["/app/app"]
M
README.md
→
README.md
@@ -3,5 +3,17 @@
A client-server reimplementation of the administration panel for ArtBound. ## Configuration -1. Copy `.env.example` into `.env` and fill it out; +1. Copy `.env.example` into `.env` and fill it out with your Sheets ID and Range; 2. [Generate](https://developers.google.com/workspace/guides/create-credentials) a `credentials.json` with Drive and Sheets APIs and the following redirect URL: `http://localhost:3000`; +3. Use `go run .` to run the server and generate a `token.json` for the first time. + +## Docker +The provided config needs the following files to be present in the main project folder: +* `.env`, for SPREADSHEET_ID and SPREADSHEET_RANGE, +* `credentials.json`, for Google API credentials, +* `token.json`, for your Google API access token. + +After you've set up everything, it's as easy as: +``` +docker-compose up -d +```
M
artbound.go
→
artbound.go
@@ -114,7 +114,6 @@ func main() {
err := godotenv.Load() if err != nil { log.Println("No .env file provided.") - os.Exit(1) } port := os.Getenv("PORT")
A
docker-compose.yaml
@@ -0,0 +1,18 @@
+services: + app: + build: . + image: ghcr.io/birabittoh/artbound-go:main + container_name: artbound-go + restart: unless-stopped + ports: + - 3000:3000 + environment: + - SPREADSHEET_ID=${SPREADSHEET_ID} + - SPREADSHEET_RANGE=${SPREADSHEET_RANGE} + volumes: + - /etc/localtime:/etc/localtime:ro + - ${PWD}/credentials.json:/app/credentials.json:ro + - ${PWD}/token.json:/app/token.json:ro + - cache:/app/static/res/cache/ +volumes: + cache: