From 0a7b0e98b268c6417b04864656b4db5c2fb7eb3e Mon Sep 17 00:00:00 2001 From: 3wc <3wc@doesthisthing.work> Date: Sun, 19 May 2024 19:14:43 -0300 Subject: [PATCH] README and .drone.yml updates Re autonomic-cooperative/astro-payload-template#3 --- .drone.yml | 20 +++++--------------- README.md | 41 +++++++++++++++++++++++++++-------------- 2 files changed, 32 insertions(+), 29 deletions(-) diff --git a/.drone.yml b/.drone.yml index 2558000..732a725 100644 --- a/.drone.yml +++ b/.drone.yml @@ -4,11 +4,11 @@ name: publish pipeline steps: - name: publish astro container image: plugins/docker - settings: + settings: &docker-build-settings username: 3wordchant password: from_secret: git_autonomic_zone_token_3wc - # NOTE: edit this if you want your image called something else + # NOTE: edit this if you want your image called something else repo: git.autonomic.zone/autonomic-cooperative/astro-payload-test-astro auto_tag: true registry: git.autonomic.zone @@ -16,29 +16,19 @@ steps: dockerfile: astro/Dockerfile - name: publish payload dev container image: plugins/docker - settings: - username: 3wordchant - password: - from_secret: git_autonomic_zone_token_3wc + settings: &payload-build-settings + << *docker-build-settings # NOTE: edit this if you want your image called something else repo: git.autonomic.zone/autonomic-cooperative/astro-payload-test-payload-dev - auto_tag: true - registry: git.autonomic.zone context: payload dockerfile: payload/Dockerfile target: dev - name: publish payload prod container image: plugins/docker settings: + <<: *payload-build-settings username: 3wordchant - password: - from_secret: git_autonomic_zone_token_3wc - # NOTE: edit this if you want your image called something else repo: git.autonomic.zone/autonomic-cooperative/astro-payload-test-payload - auto_tag: true - registry: git.autonomic.zone - context: payload - dockerfile: payload/Dockerfile target: prod - name: deploy stack image: git.coopcloud.tech/coop-cloud/stack-ssh-deploy:latest diff --git a/README.md b/README.md index fe142c1..f0ab7fb 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,16 @@ -# How to use this template +# Paystro + +Paystro is a pre-configured setup for Astro and Payloadcms, designed to make it easy for you to start building your website. With Paystro, you'll have a complete development environment that you can run locally using Docker. This setup simplifies the testing and development of your website before deploying it to a production environment. + +## Architecture + +Paystro is a fork of [Astroad](https://github.com/mooxl/astroad). + +Unlike Astroad – where the "Astro" image is the built static site served with Nginx – Paystro's Astro image is a builder image. + +In Paystro, the Docker stack just contains Payload and a generic Nginx container. + +## How to use this template 1. Create a new Gitea repository based on this template repo (choose at least "git content") @@ -11,24 +23,29 @@ To set up deployment: including adding an SSH key as an organisational secret for the organisation this project is in (see [Autonomic internal docs](https://docz.autonomic.zone/doc/setting-up-auto-deployment-using-drone-I4j2onjaKT)) -2. Edit `.drone.yml` to define the server to host on, and the +2. Edit `.drone.yml` to set variables: + - `HOST`: hostname or IP address of the server to deploy to (e.g. + `vps.example.tld`) + - `DOMAIN`: domain name of the live site (e.g. `site.example.tld`) + - `STACK_NAME`: the Docker stack name, usually `$DOMAIN` with dots replaced + with underscores (e.g. `site_example_tld`) `STACK_NAME` / `DOMAIN` of the deployed app. -3. Generate secrets (`openssl rand -hex 32` works well) for `PAYLOAD_SECRET` and +3. Make sure that DNS records for `$DOMAIN` and `admin.$DOMAIN`, pointing to + `$HOST`, are defined. +4. Generate secrets (`openssl rand -hex 32` works well) for `PAYLOAD_SECRET` and `MONGO_PASSWORD`. Insert the personal user token for a Drone bot user (e.g. `autono-bot`) as `TOKEN`). For all of them, use something like `echo "foobar" | docker secret create paystro_swarm-demo_autonomic_zone_token_v1 -`, where `paystro_swarm-demo_autonomic_zone` is the `STACK_NAME`. -4. Activate the repo in Drone +5. Activate the repo in Drone -# Paystro +--- -Paystro is a pre-configured setup for Astro and Payloadcms, designed to make it easy for you to start building your website. With Paystro, you'll have a complete development environment that you can run locally using Docker. This setup simplifies the testing and development of your website before deploying it to a production environment. - -Paystro is a fork of [Astroad](https://github.com/mooxl/astroad). +# ${REPO_NAME} ## Prerequisites -Before getting started with Paystro, make sure you have Docker installed (and, if your Docker doesn't include `docker compose`, the separate `docker-compose` tool). +Before getting started, make sure you have Docker installed (and, if your Docker doesn't include `docker compose`, the separate `docker-compose` tool). ## Configuration @@ -44,8 +61,4 @@ The `docker-compose.yml` file includes everything you need to run the containers Whenever the repository is updated, Drone builds new Docker images for Payload and Astro, and deploys a new Docker Swarm stack to the `HOST` configured in `.drone.yml`. -Unlike Astroad – where the "Astro" image is the built static site served with Nginx – Paystro's Astro image is a builder image. - -In Paystro, the Docker stack just contains Payload and a generic Nginx container. - -Whenever changes are made to Payload content, Drone uses the Astro builder image to regenerate the static site, and publish it to the Nginx container by copying it into the Docker volume. +Whenever changes are made to Payload content on the live site, Drone uses the Astro builder image to regenerate the static site, and publish it to the Nginx container by copying it into the Docker volume.