QT/sure
1
0
Fork 0
mirror of https://github.com/we-promise/sure.git synced 2026-04-19 20:14:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docker.md with new naming

Browse Source 
Signed-off-by: Juan José Mata <juanjo.mata@gmail.com>
This commit is contained in:
Juan José Mata
2025-07-29 23:11:44 +02:00
committed by GitHub
parent 35369d4eb1
commit 5223d56dc8
1 changed files with 21 additions and 22 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/hosting/docker.md
View File

@@ -1,6 +1,6 @@
# Self Hosting Maybe with Docker
# Self Hosting Sure with Docker
This guide will help you setup, update, and maintain your self-hosted Maybe application with Docker Compose. Docker Compose is the most popular and recommended way to self-host the Maybe app.
This guide will help you setup, update, and maintain your self-hosted Sure application with Docker Compose. Docker Compose is the most popular and recommended way to self-host the Sure app.
## Setup Guide
@@ -27,10 +27,10 @@ Open your terminal and create a directory where your app will run. Below is an e
```bash
# Create a directory on your computer for Docker files (name whatever you'd like)
mkdir -p ~/docker-apps/maybe
mkdir -p ~/docker-apps/sure
# Once created, navigate your current working directory to the new folder
cd ~/docker-apps/maybe
cd ~/docker-apps/sure
```
#### Copy our sample Docker Compose file
@@ -38,8 +38,8 @@ cd ~/docker-apps/maybe
Make sure you are in the directory you just created and run the following command:
```bash
# Download the sample compose.yml file from the Maybe Github repository
curl -o compose.yml https://raw.githubusercontent.com/maybe-finance/maybe/main/compose.example.yml
# Download the sample compose.yml file from the GitHub repository
curl -o compose.yml https://raw.githubusercontent.com/we-promise/sure/main/compose.example.yml
```
This command will do the following:
@@ -106,7 +106,7 @@ This will pull our official Docker image and start the app. You will see logs in
Open your browser, and navigate to `http://localhost:3000`.
If everything is working, you will see the Maybe login screen.
If everything is working, you will see the Sure login screen.
### Step 5: Create your account
@@ -117,7 +117,7 @@ The first time you run the app, you will need to register a new account by hitti
### Step 6: Run the app in the background
Most self-hosting users will want the Maybe app to run in the background on their computer so they can access it at all times. To do this, hit `Ctrl+C` to stop the running process, and then run the following command:
Most self-hosting users will want the Sure app to run in the background on their computer so they can access it at all times. To do this, hit `Ctrl+C` to stop the running process, and then run the following command:
```bash
docker compose up -d
@@ -133,26 +133,25 @@ docker compose ls
Your app is now set up. You can visit it at `http://localhost:3000` in your browser.
If you find bugs or have a feature request, be sure to read through our [contributing guide here](https://github.com/maybe-finance/maybe/wiki/How-to-Contribute-Effectively-to-this-Project).
If you find bugs or have a feature request, be sure to read through our [contributing guide here](https://github.com/we-promise/sure/wiki/How-to-Contribute-Effectively-to-this-Project).
## How to update your app
The mechanism that updates your self-hosted Maybe app is the GHCR (Github Container Registry) Docker image that you see in the `compose.yml` file:
```yml
image: ghcr.io/maybe-finance/maybe:latest
image: ghcr.io/we-promise/sure:latest
```
We recommend using one of the following images, but you can pin your app to whatever version you'd like (see [packages](https://github.com/maybe-finance/maybe/pkgs/container/maybe)):
We recommend using one of the following images, but you can pin your app to whatever version you'd like (see [packages](https://github.com/we-promise/sure/pkgs/container/maybe)):
- `ghcr.io/maybe-finance/maybe:latest` (latest commit)
- `ghcr.io/maybe-finance/maybe:stable` (latest release)
- `ghcr.io/we-promise/sure:latest` (latest commit)
- `ghcr.io/we-promise/sure:stable` (latest release)
By default, your app _will
NOT_ automatically update. To update your self-hosted app, run the following commands in your terminal:
By default, your app _will NOT_ automatically update. To update your self-hosted app, run the following commands in your terminal:
```bash
cd ~/docker-apps/maybe # Navigate to whatever directory you configured the app in
cd ~/docker-apps/sure # Navigate to whatever directory you configured the app in
docker compose pull # This pulls the "latest" published image from GHCR
docker compose build # This rebuilds the app with updates
docker compose up --no-deps -d web worker # This restarts the app using the newest version
@@ -163,7 +162,7 @@ docker compose up --no-deps -d web worker # This restarts the app using the newe
If you'd like to pin the app to a specific version or tag, all you need to do is edit the `compose.yml` file:
```yml
image: ghcr.io/maybe-finance/maybe:stable
image: ghcr.io/we-promise/sure:stable
```
After doing this, make sure and restart the app:
@@ -178,17 +177,17 @@ docker compose up --no-deps -d app # This restarts the app using the newest vers
### ActiveRecord::DatabaseConnectionError
If you are trying to get Maybe started for the **first time** and run into database connection issues, it is likely because Docker has already initialized the Postgres database with a _different_ default role (usually from a previous attempt to start the app).
If you are trying to get Sure started for the **first time** and run into database connection issues, it is likely because Docker has already initialized the Postgres database with a _different_ default role (usually from a previous attempt to start the app).
If you run into this issue, you can optionally **reset the database**.
**PLEASE NOTE: this will delete any existing data that you have in your Maybe database, so proceed with caution.** For first-time users of the app just trying to get started, you're generally safe to run the commands below.
**PLEASE NOTE: this will delete any existing data that you have in your Sure database, so proceed with caution.** For first-time users of the app just trying to get started, you're generally safe to run the commands below.
By running the commands below, you will delete your existing Maybe database and "reset" it.
By running the commands below, you will delete your existing Sure database and "reset" it.
```
docker compose down
docker volume rm maybe_postgres-data # this is the name of the volume the DB is mounted to
docker volume rm sure_postgres-data # this is the name of the volume the DB is mounted to
docker compose up
docker exec -it maybe-postgres-1 psql -U maybe -d maybe_production -c "SELECT 1;" # This will verify that the issue is fixed
docker exec -it sure-postgres-1 psql -U maybe -d maybe_production -c "SELECT 1;" # This will verify that the issue is fixed
```