docker compose up testing, fixed paths for flatnotes to be a in a notes directory for quick notes, env testing, readme clean up

This commit is contained in:
admin 2025-05-12 15:21:00 -06:00
parent 45a0ec3eec
commit 771353a8e7
6 changed files with 54 additions and 49 deletions

50
.env
View File

@ -1,16 +1,16 @@
# Never share this file publicly. It contains sensitive information. # Never share this file publicly. It contains sensitive information.
# This file is used to configure various applications and services. # This file is used to configure various applications and services.
# Generated by Changemaker Config Wizard on Sun 11 May 2025 10:05:17 PM MDT # Generated by Changemaker Config Wizard on Mon 12 May 2025 02:58:29 PM MDT
# Domain Configuration # Domain Configuration
DOMAIN=test.com DOMAIN=bnkops.com
BASE_DOMAIN=https://test.com BASE_DOMAIN=https://bnkops.com
# Listmonk Configuration # Listmonk Configuration
LISTMONK_ADMIN_USER=admin LISTMONK_ADMIN_USER=admin
LISTMONK_ADMIN_PASSWORD=@thebunker LISTMONK_ADMIN_PASSWORD=@thebunker
LISTMONK_PORT=9000 LISTMONK_PORT=9000
LISTMONK_HOSTNAME=listmonk.test.com LISTMONK_HOSTNAME=listmonk.bnkops.com
# Database Credentials # Database Credentials
POSTGRES_USER=listmonk POSTGRES_USER=listmonk
@ -18,12 +18,12 @@ POSTGRES_PASSWORD=7Cl6OUA6KrJ1fQ0l/ZwJ
POSTGRES_DB=listmonk POSTGRES_DB=listmonk
# Monica CRM Configuration # Monica CRM Configuration
MONICA_APP_KEY=base64:MHdHU1ovVGtVV3BDUHdqNXNudXZaa1AzdzB5Y1luTTQ= MONICA_APP_KEY=base64:dFM2dWRIZjRRb0gxaVhNUkpJR1dyMWx2Mm1Zem8wbWQ=
MONICA_DB_USERNAME=monica MONICA_DB_USERNAME=monica
MONICA_DB_PASSWORD=PERGF5DgEJgdxxKg5OmR MONICA_DB_PASSWORD=aVEQ2UyTLR9OrXLkMxuS
MONICA_MYSQL_DATABASE=monica MONICA_MYSQL_DATABASE=monica
MONICA_MYSQL_USER=monica MONICA_MYSQL_USER=monica
MONICA_MYSQL_PASSWORD=PERGF5DgEJgdxxKg5OmR MONICA_MYSQL_PASSWORD=aVEQ2UyTLR9OrXLkMxuS
# MkDocs Configuration # MkDocs Configuration
USER_ID=1000 USER_ID=1000
@ -36,7 +36,7 @@ FLATNOTES_PGID=1000
FLATNOTES_AUTH_TYPE=password FLATNOTES_AUTH_TYPE=password
FLATNOTES_USERNAME=admin FLATNOTES_USERNAME=admin
FLATNOTES_PASSWORD=@thebunker FLATNOTES_PASSWORD=@thebunker
FLATNOTES_SECRET_KEY=TA2QZssp/Q+36YGIlkYdqkK9R682wCfc FLATNOTES_SECRET_KEY=0bx2WKdcLETMDy6/ZFIkxNO7OzPdN4a4
FLATNOTES_PORT=8089 FLATNOTES_PORT=8089
# Gitea Configuration # Gitea Configuration
@ -44,12 +44,12 @@ GITEA_DB_TYPE=mysql
GITEA_DB_HOST=gitea-db:3306 GITEA_DB_HOST=gitea-db:3306
GITEA_DB_NAME=gitea GITEA_DB_NAME=gitea
GITEA_DB_USER=gitea GITEA_DB_USER=gitea
GITEA_DB_PASSWD=mdBJ8OKtHQLnbsrrKHOcabfq GITEA_DB_PASSWD=L3BpWgZ9m5ukr9ecbTSnDt/0
GITEA_DB_ROOT_PASSWORD=MB7m9n5koGR51eSKckQzI0jh GITEA_DB_ROOT_PASSWORD=ReBu0Vuaj6hgZxlFtIk4F9hC
GITEA_WEB_PORT=3030 GITEA_WEB_PORT=3030
GITEA_SSH_PORT=2225 GITEA_SSH_PORT=2225
GITEA_ROOT_URL=https://gitea.test.com GITEA_ROOT_URL=https://gitea.bnkops.com
GITEA_DOMAIN=gitea.test.com GITEA_DOMAIN=gitea.bnkops.com
# Apache Answer Configuration # Apache Answer Configuration
ANSWER_APP_PORT=9080 ANSWER_APP_PORT=9080
@ -58,8 +58,8 @@ ANSWER_APP_PORT=9080
EXCALIDRAW_PORT=3333 EXCALIDRAW_PORT=3333
EXCALIDRAW_LIBRARY_URL=https://libraries.excalidraw.com EXCALIDRAW_LIBRARY_URL=https://libraries.excalidraw.com
EXCALIDRAW_LIBRARY_BACKEND=https://us-central1-excalidraw-room-persistence.cloudfunctions.net/libraries # do not alter this URL EXCALIDRAW_LIBRARY_BACKEND=https://us-central1-excalidraw-room-persistence.cloudfunctions.net/libraries # do not alter this URL
EXCALIDRAW_PUBLIC_URL=https://excalidraw.test.com EXCALIDRAW_PUBLIC_URL=https://excalidraw.bnkops.com
EXCALIDRAW_PUBLIC_SOCKET_URL=https://excalidraw.test.com EXCALIDRAW_PUBLIC_SOCKET_URL=https://excalidraw.bnkops.com
# Code Server Configuration # Code Server Configuration
CODE_SERVER_PORT=8888 CODE_SERVER_PORT=8888
@ -67,40 +67,40 @@ USER_NAME=coder
# Cloudflare Credentials # Cloudflare Credentials
CF_AUTH_EMAIL=admin@thebunkerops.ca CF_AUTH_EMAIL=admin@thebunkerops.ca
CF_API_TOKEN=redacted CF_API_TOKEN=KB2QrTTr5BPbyRs-fBtb7A6bYjf65YtBwaDiCs48
CF_ZONE_ID=redacted CF_ZONE_ID=7e385609784979b1f96763f04d759baf
CF_TUNNEL_ID=redacted CF_TUNNEL_ID=[update]
CF_DOMAIN=test.com CF_DOMAIN=bnkops.com
# NocoDB Configuration # NocoDB Configuration
NOCODB_PORT=8090 NOCODB_PORT=8090
NOCODB_JWT_SECRET=G+bgOQAW8CtcFaNGGLOlNI+Yt3y4j08f NOCODB_JWT_SECRET=XeTjxikWD+8G/wa/TMd7/MLdPbKjc79Y
NOCODB_DB_NAME=nocodb NOCODB_DB_NAME=nocodb
NOCODB_DB_USER=noco NOCODB_DB_USER=noco
NOCODB_DB_PASSWORD=puStVPzzH8HK5wi5KefK NOCODB_DB_PASSWORD=sdUlNR21SQwwW0seSiFr
# OpenWebUI Configuration # OpenWebUI Configuration
OPEN_WEBUI_PORT=3005 OPEN_WEBUI_PORT=3005
OPEN_WEBUI_URL=https://open-webui.test.com OPEN_WEBUI_URL=https://open-webui.bnkops.com
# N8N Configuration # N8N Configuration
N8N_PORT=5678 N8N_PORT=5678
N8N_HOST=n8n.test.com N8N_HOST=n8n.bnkops.com
N8N_ENCRYPTION_KEY=PtiJxEiaCkGoKkbNjqrddo0gWTW/RYGC N8N_ENCRYPTION_KEY=nj03H7B30InmS+ox3yT2B2ZhzsWTDkGJ
N8N_USER_EMAIL=admin@thebunkerops.ca N8N_USER_EMAIL=admin@thebunkerops.ca
N8N_USER_PASSWORD=@thebunker N8N_USER_PASSWORD=@thebunker
GENERIC_TIMEZONE=UTC GENERIC_TIMEZONE=UTC
# ConvertX Configuration # ConvertX Configuration
CONVERTX_PORT=3100 CONVERTX_PORT=3100
CONVERTX_JWT_SECRET=BNOqzXdgchufkbsBA+s8NTHuRJcIVfOha0dSyQZz45o6ym/X CONVERTX_JWT_SECRET=MO0a6/FadD7DdcCxM4+DDNKoM9Zpq2KgVaABWupLexaSVfCh
# Rocket.Chat Configuration # Rocket.Chat Configuration
ROCKETCHAT_IMAGE=registry.rocket.chat/rocketchat/rocket.chat ROCKETCHAT_IMAGE=registry.rocket.chat/rocketchat/rocket.chat
ROCKETCHAT_RELEASE=latest ROCKETCHAT_RELEASE=latest
ROCKETCHAT_PORT=3004 ROCKETCHAT_PORT=3004
ROCKETCHAT_CONTAINER_PORT=3000 ROCKETCHAT_CONTAINER_PORT=3000
ROCKETCHAT_ROOT_URL=https://rocket.test.com ROCKETCHAT_ROOT_URL=https://rocket.bnkops.com
ROCKETCHAT_DEPLOYMENT_ENVIRONMENT=production ROCKETCHAT_DEPLOYMENT_ENVIRONMENT=production
ROCKETCHAT_MONGODB_VERSION=6.0 ROCKETCHAT_MONGODB_VERSION=6.0
ROCKETCHAT_MONGODB_HOST=mongodb-rocketchat ROCKETCHAT_MONGODB_HOST=mongodb-rocketchat

6
.gitignore vendored
View File

@ -12,8 +12,8 @@ configs/ferdium/*
!configs/ferdium/.gitkeep !configs/ferdium/.gitkeep
# flatnotes directory # flatnotes directory
mkdocs/docs/blog/posts/.flatnotes/* mkdocs/docs/notes/.flatnotes/*
!mkdocs/docs/blog/posts/.flatnotes/.gitkeep !mkdocs/docs/notes/.flatnotes/.gitkeep
# attachments directory # attachments directory
mkdocs/docs/blog/posts/attachments/* mkdocs/docs/blog/posts/attachments/*
@ -38,4 +38,6 @@ convertx-data/*
answer-data/* answer-data/*
!answer-data/.gitkeep !answer-data/.gitkeep
.vscode .vscode

View File

@ -76,12 +76,14 @@ git clone https://gitea.bnkhome.org/bnkops/Changemaker.git
cd changemaker cd changemaker
``` ```
See [Setting Up Cloudflare Credentials](#setting-up-cloudflare-credentials) for how to get cloudflare credentials for config.sh.
```bash ```bash
# Use default configuration for development or run the config script for configuration # Use default configuration for local development.
# To optionally configure, first make the script executable: # To configure for remote deployment with Cloudflare, first make the script executable:
chmod +x config.sh chmod +x config.sh
# Then run the configuration script: # Then run the configuration script. You will need your Cloudflare details.
./config.sh ./config.sh
``` ```
@ -90,23 +92,23 @@ chmod +x config.sh
docker compose up -d docker compose up -d
``` ```
**[!Warning] Configure Portainer & Install Gitea**
Portainer has a timed build process. Make sure to immediatly configure the service by visiting https://localhost:9444
Gitea has a install process that you should complete on first build.
**First time installation can take several miniutes** **First time installation can take several miniutes**
On a 1GB internet connection, instal time is approximately 3 minutes. On a 1GB internet connection, instal time is approximately 5 minutes.
### ⚠️ Configure Portainer Immediately 🦊
Portainer has a timed build process that needs to be completed on successful build. Proceed to configure the service by visiting https://localhost:9444
Gitea has a install process that you should complete immediately after connecting system to dns and domain services.
### On Successful Build, Vist [Local Homepage](http://localhost:3011)
The [local homepage - http://localhost:3011]((http://localhost:3011)) is configured with all of the services you can access securely locally.
To access services outside of network, configure a VPN, Tailscale, or continue to Cloudflare publishing documentation.
## Local Service Ports ## Local Service Ports
## Local Service Ports
### Local [Homepage http://localhost:3011](http://localhost:3011)
The local homepage is configured with all of the services you can access securely on your own device.
When running Changemaker locally, you can access the services at the following ports on your server: When running Changemaker locally, you can access the services at the following ports on your server:
| Service | Local Port | Local URL | | Service | Local Port | Local URL |
@ -122,12 +124,12 @@ When running Changemaker locally, you can access the services at the following p
| Ollama | 11435 | [http://localhost:11435](http://localhost:11435) | | Ollama | 11435 | [http://localhost:11435](http://localhost:11435) |
| OpenWebUI | 3005 | [http://localhost:3005](http://localhost:3005) | | OpenWebUI | 3005 | [http://localhost:3005](http://localhost:3005) |
| Gitea | 3030 | [http://localhost:3030](http://localhost:3030) | | Gitea | 3030 | [http://localhost:3030](http://localhost:3030) |
| Portainer | 8005 | [http://localhost:8005](http://localhost:8005) | | Portainer | 8005 | [https://localhost:9444](https://localhost:9444) |
| Mini QR | 8081 | [http://localhost:8081](http://localhost:8081) | | Mini QR | 8081 | [http://localhost:8081](http://localhost:8081) |
| Ferdium | 3006 | [http://localhost:3006](http://localhost:3006) | | Ferdium | 3009 | [http://localhost:3009](http://localhost:3009) |
| Answer | 9080 | [http://localhost:9080](http://localhost:9080) | | Answer | 9080 | [http://localhost:9080](http://localhost:9080) |
| NocoDB | 8090 | [http://localhost:8090](http://localhost:8090) | | NocoDB | 8090 | [http://localhost:8090](http://localhost:8090) |
| n8n | 5678 | [https://localhost:5678](https://localhost:5678) | | n8n | 5678 | [http://localhost:5678](http://localhost:5678) |
| ConvertX | 3100 | [http://localhost:3100](http://localhost:3100) | | ConvertX | 3100 | [http://localhost:3100](http://localhost:3100) |
| Rocket.Chat | 3004 | [http://localhost:3004](http://localhost:3004) | | Rocket.Chat | 3004 | [http://localhost:3004](http://localhost:3004) |
@ -250,7 +252,8 @@ This script will add CNAME records for all Changemaker services to your Cloudfla
It will also set up a Cloudflare Access Application for all services execpt for your website and gitea. This is a extra layer of security that we do recommend for your deployment. It will automatically allow any emails with from the root domain that you set in the `config.sh` process. For example, if you set your root domain to `example.com` your access rule will allow emails ending with @example.com thorugh. You can update your access settings in the Cloudflare Zero Trust dashboard. It will also set up a Cloudflare Access Application for all services execpt for your website and gitea. This is a extra layer of security that we do recommend for your deployment. It will automatically allow any emails with from the root domain that you set in the `config.sh` process. For example, if you set your root domain to `example.com` your access rule will allow emails ending with @example.com thorugh. You can update your access settings in the Cloudflare Zero Trust dashboard.
> [!warning] Cloudflare Zero Trust > [!warning] ⚠️ Cloudflare Zero Trust ⚠️
To ensure that system is secure, we highly recommend setting up some level of access control using Cloudflare Zero Trust. The `add-cname-records.sh` will do this automatically however the user is encouraged to familiarize themselves with Cloudflares Zero Trust access system. To ensure that system is secure, we highly recommend setting up some level of access control using Cloudflare Zero Trust. The `add-cname-records.sh` will do this automatically however the user is encouraged to familiarize themselves with Cloudflares Zero Trust access system.
## Website Build and Deployment Workflow ## Website Build and Deployment Workflow

View File

@ -48,7 +48,7 @@
description: Q&A platform for teams description: Q&A platform for teams
icon: mdi-help-circle icon: mdi-help-circle
- Ferdium: - Ferdium:
href: http://localhost:3006 href: http://localhost:3009
description: All-in-one messaging app description: All-in-one messaging app
icon: ferdium icon: ferdium
- Rocket.Chat: - Rocket.Chat:
@ -74,6 +74,6 @@
description: File conversion tool description: File conversion tool
icon: mdi-file-sync icon: mdi-file-sync
- n8n: - n8n:
href: https://localhost:5678 href: http://localhost:5678
description: Workflow automation description: Workflow automation
icon: n8n icon: n8n

View File

@ -261,7 +261,7 @@ services:
FLATNOTES_PASSWORD: ${FLATNOTES_PASSWORD} FLATNOTES_PASSWORD: ${FLATNOTES_PASSWORD}
FLATNOTES_SECRET_KEY: ${FLATNOTES_SECRET_KEY} FLATNOTES_SECRET_KEY: ${FLATNOTES_SECRET_KEY}
volumes: volumes:
- ./mkdocs/docs/blog/posts:/data - ./mkdocs/docs/notes:/data
ports: ports:
- "${FLATNOTES_PORT:-8080}:8080" - "${FLATNOTES_PORT:-8080}:8080"
restart: unless-stopped restart: unless-stopped