builds.sr.ht can be used to automate the deployment of websites, signing of packages, and more, through the use of build secrets. You can upload the secret keys necessary to run your automation on the web, then make these secrets available to CI jobs.
Let's say we have a git repo with static HTML files that we'd like to deploy by sending them to our web server. A simple build manifest might look like this:
image: alpine/edge packages: - rsync sources: - https://git.sr.ht/~you/example.org tasks: - upload: | rsync -r example.org/* example.org:/var/www/
This is straightforward enough - but it won't work because the build won't have authorization to log into example.org.
This step will naturally be somewhat different depending on your particular server configuration. You should start by creating a deploy user:
useradd -m deploy
Let's also give this user permission to update
usermod -aG www-data deploy chgrp www-data /var/www chmod g+rwx /var/www
And finally, let's log in as
deploy and generate an SSH key:
sudo su deploy ssh-keygen # accept the defaults cat .ssh/id_rsa.pub >> .ssh/authorized_keys cat .ssh/id_rsa
This will print out the new SSH private key. Copy this to your clipboard for the next step.
Go to the builds.sr.ht secret management
dashboard and select
SSH key for secret type,
then paste your key into the text box. Click
submit - and your new secret
should show up on the right, along with its UUID.
This UUID is used to uniquely identify this secret in build manifests. Copy this UUID for the next step.
This part is easy. We can simply add a list of secret UUIDs we want to be available in this build.
image: alpine/edge secrets: - c262b238-41de-4b43-a2f9-460424dd7896 packages: - rsync sources: - https://git.sr.ht/~you/example.org tasks: - upload: | rsync -r example.org/* example.org:/var/www/
It's as easy as that! builds.sr.ht will install this SSH key into your build environment when you submit this build manifest. However, it will only work for builds submitted with your user - if someone else copies and pastes this build manifest, the SSH key will not be added to their build VM.
The easiest way to control whether or not secrets work in your build is by turning them off via the API: if you set secrets=false in POST /api/jobs, the secrets will not be resolved. This is automatically done in many places where the build manifest could be modified by an untrusted party - for example, dispatch.sr.ht disables secrets when submitting build manifests from GitHub pull requests.
However, some degree of responsibility lies with you for keeping your secrets secure. Avoid writing build manifests that would print your secrets to the logs, particularly if using file secrets. If a secret is ever leaked in this manner, you should consider that secret compromised - revoke it and generate a new one.