Skip to content

Add Documentation for changes to Docker #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
BluetonicBeats wants to merge 1 commit into
base: v1
Choose a base branch
from
Open

Add Documentation for changes to Docker #69

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 18 additions & 1 deletion docs/installation/docker.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -55,4 +55,21 @@ This will prompt you for the username, email and password of the user.
docker compose exec paymenter php artisan app:user:create
```

Now your dockerized Paymenter installation is ready to use! The default port is `80`
## Building and Deploying the Default Theme

::: info
After installation or updates, you must build the default theme and switch to it, as updates may break other themes.
:::

Run the following command to build the default theme:
```bash
docker compose run --rm asset-builder npm install
docker compose run --rm asset-builder npm run build default
```

Run the following command to switch to the default theme:
```bash
docker compose exec paymenter php artisan app:settings:change theme
```

Now your dockerized Paymenter installation is ready to use! The default port is `80`
20 changes: 19 additions & 1 deletion docs/installation/updating.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,31 @@ If your current version is below 1.0.0, please follow the [migration guide](/doc
::: details For docker users
If you are using the docker version of Paymenter, use the following commands to update:

::: warning
The `docker compose down -v` command clears non-persistent volumes (including built themes and extensions), which is necessary for the update. Themes and extensions source files are stored in persistent volumes and will be retained. This assumes you haven't made significant modifications to the default docker-compose file. If you have customized your setup extensively, please back up your data before proceeding with the update.
:::

```bash
docker compose pull
docker compose up -d
docker compose down -v
docker compose up -d --force-recreate
```

::: info
After the update completes, you must build the default theme and switch to it, as updates may break other themes.
:::

Run following command to build the default theme:
```bash
docker compose run --rm asset-builder npm install
docker compose run --rm asset-builder npm run build default
Copy link
Copy Markdown
Member

@CorwinDev CorwinDev Jan 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why is this neccesary? Doesn't a docker update contain the build files?

Copy link
Copy Markdown
Author

@BluetonicBeats BluetonicBeats Jan 24, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good catch! You're right - the Docker container does come with the compiled build files, and they're stored in volumes so they persist across updates. The rebuild step isn't strictly necessary for a normal update.

However, I've found that in some instances, the default build files can go missing or the theme gets unset, which leaves the user with a broken setup. The rebuild commands are more of a failsafe/recovery step to get things back to a working state if something fails during the update.

Since it's not a mandatory part of the update process, how about we're actually moving these instructions to the FAQ as a troubleshooting tip: "If your theme isn't loading or assets are missing after an update, try rebuilding the default theme."

```

Run the following command to switch to the default theme:
```bash
docker compose exec paymenter php artisan app:settings:change theme
```

## Automatic update

Run the following command in your terminal:
Expand Down