andrew/alembic
1
0
Fork 0
Code Pull Requests Actions Releases 12 Wiki Activity

README: pull the prebuilt image instead of building (v0.5)

Browse Source 
Point the install at the published image (git.kretzer.club/andrew/alembic:0.5)
now that v0.5 is on the registry: docker pull instead of clone+build, the
compose example uses the registry image, and Updating is docker compose
pull/up instead of git pull + build. Setup, credentials, and day-to-day
sections are unchanged.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This commit is contained in:
andrew
2026-07-10 16:30:48 -06:00
parent 543f10e662
commit fdcba992fd
1 changed files with 12 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+12 -12
View File
@@ -70,15 +70,15 @@ Optional, add these later if you want them:
### 1. Get the image
Clone this repository onto your Docker host and build the image locally:
Pull the prebuilt image onto your Docker host:
```bash
git clone <this-repo-url> alembic
cd alembic
docker build -t alembic:latest .
docker pull git.kretzer.club/andrew/alembic:0.5
```
This takes a few minutes the first time. You don't need to touch anything inside the `app/` or `pipeline/` folders, the Dockerfile handles all of it.
That is the whole install. You do not need to download the source or build anything. The `0.5` is the version; you can pin to it so nothing changes under you, or use `latest` to always get the newest.
(If you would rather build it yourself from source, you can, but you do not need to.)
### 2. Create your folders
@@ -131,12 +131,12 @@ In return, it will give you three values you'll need in the next step:
### 5. Write your docker-compose file
Create a `docker-compose.yml` next to your alembic folder:
Create a file called `docker-compose.yml` on your server (put it wherever you keep your other compose files):
```yaml
services:
alembic:
image: alembic:latest
image: git.kretzer.club/andrew/alembic:0.5
container_name: alembic
ports:
- "8420:8420"
@@ -220,15 +220,15 @@ That's it. On its next scheduled run (or immediately, using the **Run now** butt
## Updating alembic
Pull the latest code, rebuild, and restart:
When a new version is released, change the version in your `docker-compose.yml` (for example `:0.5` to the new number), then pull and restart:
```bash
cd alembic
git pull
docker build -t alembic:latest .
docker compose up -d --force-recreate alembic
docker compose pull
docker compose up -d
```
If you used the `latest` tag instead of a version number, you can skip the edit and just run those two commands.
Your library, credentials, and settings all live in your mounted folders, so updating the image never touches your data.
## Backups