Skip to content

Commit

Permalink
add note about litestream-entrypoint.sh to README
Browse files Browse the repository at this point in the history
  • Loading branch information
NiklasRosenstein committed Oct 14, 2024
1 parent 044f4e7 commit 69a680e
Showing 1 changed file with 13 additions and 0 deletions.
13 changes: 13 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ __Contents__
* [Environment variables](#environment-variables)
* [Migrating to Headscale on Fly.io](#migrating-to-headscale-on-flyio)
* [Migrating from Postgres](#migrating-from-postgres)
* [litestream-entrypoint.sh](#litestream-entrypointsh)
* [Development](#development)
* [Integration testing](#integration-testing)
<!-- end toc -->
Expand Down Expand Up @@ -284,6 +285,18 @@ S3 bucket. Then re-deploy to remove the `IMPORT_DATABASE` variable.

You should be good to go!

### litestream-entrypoint.sh

As part of this repository, the [`litestream-entrypoint.sh`](./headscale-fly-io/litestream-entrypoint.sh) can be
considered public API can consumed by other projects that want to use Litestream in the same fashion as this project.
It can be retrieved with curl or copied from the container published by the project under the
`/var/lib/headscale/litestream-entrypoint.sh` path, however you must pin a tagged version to ensure reproducability and
compatibility (newer versions might change in a backwards incompatible way).

Other projects that use this script include:

* [NiklasRosenstein/vaultwarden-on-fly](https://github.com/NiklasRosenstein/vaultwarden-fly-io)

## Development

Simply iterating via `fly deploy` works quite well!
Expand Down

0 comments on commit 69a680e

Please sign in to comment.