flow/services
1
0
Fork 0
Code Issues 1 Pull requests Projects Releases Activity
services/README.asciidoc
Dan Anglin 5f675e7b9e
docs: update README
2023-12-16 17:20:48 +00:00

1.8 KiB
Raw Blame History

Flow Services

Overview

The repository manages the services hosted on Flow Platform with the use of Go and Mage.

Currently hosted services

Name Description Link

Landing

The front page of the Flow Platform.

https://dananglin.me.uk

Free Flow

A single-user ActivityPub instance powered by GoToSocial.

https://freeflow.dananglin.me.uk

Code Flow

The Flow Platform’s software forge powered by Forgejo.

https://codeflow.dananglin.me.uk

Work Flow

A simple CI engine powered by Woodpecker.

https://workflow.dananglin.me.uk

Mage targets

$ mage -l
Targets:
  clean       cleans the workspace.
  deploy      deploys the services to the Flow Platform.
  prepare     prepares the service's build directory.
  shutdown    shuts down the Flow Platform in a given environment.
  stop        stops a running service within the Flow Platform.

Deployment guide

The config directory contains the Flow Platform’s configuration (e.g. versions of hosted software, etc). It is a submodule of a hidden repository due to the sensitive nature of the configuration.

  1. (Optional) Run mage prepare <environment> <service> to run preparations before deployment. Here the relevant files to run the service are downloaded, templates are rendered and static assets are copied to the build directory (if required). Step is optional because the 'deploy' stage automatically runs 'prepare' as a dependency. For example:

    mage prepare production forgejo

  2. To deploy changes to Platform, run mage deploy <environment> <service>. The deploy target runs the prepare target as a dependency. For example:

    mage deploy production forgejo