Skip to content

A local-first personal finance app

:sparkles: New Docker Hub org in CI and README (#175)

Trevor Farlowc3d89b6509a2
diff --git a/.github/workflows/docker-edge.yml b/.github/workflows/docker-edge.yml
index b06ce81450..1fac479d1a 100644
--- a/.github/workflows/docker-edge.yml
+++ b/.github/workflows/docker-edge.yml
@@ -20,8 +20,9 @@ permissions:
env:
IMAGES: |
- jlongster/actual-server
+ actualbudget/actual-server
ghcr.io/actualbudget/actual-server
+ jlongster/actual-server
# Creates the following tags:
# - actual-server:edge
diff --git a/.github/workflows/docker-release.yml b/.github/workflows/docker-release.yml
index b409388ebb..e9ae30ced3 100644
--- a/.github/workflows/docker-release.yml
+++ b/.github/workflows/docker-release.yml
@@ -11,8 +11,9 @@ on:
env:
IMAGES: |
- jlongster/actual-server
+ actualbudget/actual-server
ghcr.io/actualbudget/actual-server
+ jlongster/actual-server
# Creates the following tags:
# - actual-server:latest (see docker/metadata-action flavor inputs, below)
diff --git a/README.md b/README.md
index 06e321bba7..dc653e214e 100644
--- a/README.md
+++ b/README.md
@@ -20,6 +20,7 @@ yarn start
Go to https://localhost:5006 in your browser and you'll see Actual.
## Running via Docker
+
To run using a Docker container you can use following commands;
```
@@ -31,7 +32,6 @@ docker run -p 5006:5006 actual-server
The multi-arch Docker container image runs on amd64, arm64, and armv7 platforms. Please be warned that Actual may be sluggish on armv7, but users report that it does work.
-
## Deploying
You should deploy your server so it's always running. We recommend [fly.io](https://fly.io) which makes it incredibly easy and provides a free plan.
@@ -46,13 +46,13 @@ Copy `fly.template.toml` to `fly.toml`. Open `fly.toml` and customize the app na
Now, run `flyctl launch` from `actual-server`. You should have a running app now! To get to the Actual UI, simply run `flyctl open`
-Whenever you want to update Actual, update the versions of `@actual-app/api` and `@actual-app/web` in `package.json` and run `flyctl deploy`.
+Whenever you want to update Actual, update the versions of `@actual-app/api` and `@actual-app/web` in `package.json` and run `flyctl deploy`.
### Using a custom Docker setup
Actual is also available as a Docker image ready to be run in your own custom environment.
-- Docker Hub: `jlongster/actual-server`
+- Docker Hub: `actualbudget/actual-server`
- Github Registry: `ghcr.io/actualbudget/actual-server`
### Persisting server data
@@ -75,12 +75,11 @@ Now we need to tell Actual to use this volume. Add this in `fly.toml`:
That's it! Actual will automatically check if the `/data` directory exists and use it automatically.
-
### One-click hosting solutions
These are non-official methods of one-click solutions for running Actual. If you provide a service like this, feel free to open a PR and add it to this list. These run Actual via a Docker image.
-* PikaPods: [Run on PikaPods](https://www.pikapods.com/pods?run=actual)
+- PikaPods: [Run on PikaPods](https://www.pikapods.com/pods?run=actual)
## Configuring the server
@@ -93,4 +92,3 @@ The Actual app is totally separate from the server. In this project, they happen
The server could live on a completely different domain. You might setup Actual so that the app and server are running in completely separate places.
Since Actual doesn't know what server to use, the first thing it does is asks you for the server URL. If you are running this project, simply click "Use this domain" and it will automatically fill it in with the current domain. This works because we are serving the app and server in the same place.
-
diff --git a/docker-compose.yml b/docker-compose.yml
index d55e33c7fd..4c8afc83bc 100644
--- a/docker-compose.yml
+++ b/docker-compose.yml
@@ -1,11 +1,11 @@
version: '3'
services:
actual_server:
- image: jlongster/actual-server:latest
+ image: actualbudget/actual-server:latest
ports:
# This line makes Actual available at port 5006 of the device you run the server on,
# i.e. http://localhost:5006. You can change the first number to change the port, if you want.
- - "5006:5006"
+ - '5006:5006'
environment:
# Uncomment any of the lines below to set configuration options.
# - ACTUAL_HTTPS_KEY=/data/selfhost.key
diff --git a/upcoming-release-notes/175.md b/upcoming-release-notes/175.md
new file mode 100644
index 0000000000..89d4165c97
--- /dev/null
+++ b/upcoming-release-notes/175.md
@@ -0,0 +1,6 @@
+---
+category: Maintenance
+authors: [trevdor]
+---
+
+Push Docker images to new `actualbudget` Docker Hub organization.