bnkops/Changemaker
bnkops/Changemaker
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Changemaker/mkdocs/site/readme/index.html

1698 lines
46 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Demo site for Changemaker">
<meta name="author" content="Bunker Ops">
<link rel="canonical" href="http://betteredmonton.org/readme/">
<link rel="prev" href="..">
<link rel="next" href="../apps/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
<title>About Changemaker - Changemaker Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../stylesheets/extra.css">
<link rel="stylesheet" href="https://fonts.googleapis.com/icon?family=Material+Icons">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="About Changemaker - Changemaker Documentation" >
<meta property="og:description" content="Demo site for Changemaker" >
<meta property="og:image" content="http://betteredmonton.org/assets/images/social/readme.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="http://betteredmonton.org/readme/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="About Changemaker - Changemaker Documentation" >
<meta name="twitter:description" content="Demo site for Changemaker" >
<meta name="twitter:image" content="http://betteredmonton.org/assets/images/social/readme.png" >
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#changemaker-v5" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
<aside class="md-banner">
<div class="md-banner__inner md-grid md-typeset">
<a href="https://homepage.betteredmonton.org" class="login-button">Login</a>
This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">Learn more</a>
</div>
</aside>
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Changemaker Documentation" class="md-header__button md-logo" aria-label="Changemaker Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Changemaker Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
About Changemaker
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
About Changemaker
</a>
</li>
<li class="md-tabs__item">
<a href="../apps/" class="md-tabs__link">
Test
</a>
</li>
<li class="md-tabs__item">
<a href="../apps/" class="md-tabs__link">
Applications
</a>
</li>
<li class="md-tabs__item">
<a href="../guides/authoring-content/" class="md-tabs__link">
Guides
</a>
</li>
<li class="md-tabs__item">
<a href="../ollama.md" class="md-tabs__link">
Ollama Setup (Legacy)
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Changemaker Documentation" class="md-nav__button md-logo" aria-label="Changemaker Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
Changemaker Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
About Changemaker
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
About Changemaker
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#currated-suite-of-applications" class="md-nav__link">
<span class="md-ellipsis">
Currated Suite of Applications
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#_1" class="md-nav__link">
<span class="md-ellipsis">
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#contents" class="md-nav__link">
<span class="md-ellipsis">
Contents
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#development-pathway" class="md-nav__link">
<span class="md-ellipsis">
Development Pathway
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#quick-start-for-local-dev" class="md-nav__link">
<span class="md-ellipsis">
Quick Start for Local Dev
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#local-service-ports" class="md-nav__link">
<span class="md-ellipsis">
Local Service Ports
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#detailed-installation" class="md-nav__link">
<span class="md-ellipsis">
Detailed Installation
</span>
</a>
<nav class="md-nav" aria-label="Detailed Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#ubuntu-os-build-outs" class="md-nav__link">
<span class="md-ellipsis">
Ubuntu OS &amp; Build Outs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#1-install-docker-and-docker-compose" class="md-nav__link">
<span class="md-ellipsis">
1. Install Docker and Docker Compose
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-clone-the-repository" class="md-nav__link">
<span class="md-ellipsis">
2. Clone the Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-configure-your-environment" class="md-nav__link">
<span class="md-ellipsis">
2. Configure Your Environment
</span>
</a>
<nav class="md-nav" aria-label="2. Configure Your Environment">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#setting-up-cloudflare-credentials" class="md-nav__link">
<span class="md-ellipsis">
Setting Up Cloudflare Credentials
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#4-start-the-services" class="md-nav__link">
<span class="md-ellipsis">
4. Start the Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-cloudflare-tunnel-setup" class="md-nav__link">
<span class="md-ellipsis">
4. Cloudflare Tunnel Setup
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#install-cloudflared-on-ubuntu-2404" class="md-nav__link">
<span class="md-ellipsis">
Install Cloudflared on Ubuntu 24.04
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#configure-your-cloudflare-tunnel" class="md-nav__link">
<span class="md-ellipsis">
Configure Your Cloudflare Tunnel
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-a-cloudflare-system-service" class="md-nav__link">
<span class="md-ellipsis">
Create a Cloudflare System Service
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#add-cname-records" class="md-nav__link">
<span class="md-ellipsis">
Add CNAME Records
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#accessing-your-services" class="md-nav__link">
<span class="md-ellipsis">
Accessing Your Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../apps/" class="md-nav__link">
<span class="md-ellipsis">
Test
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Applications
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Applications
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../apps/" class="md-nav__link">
<span class="md-ellipsis">
Test
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/homepage/" class="md-nav__link">
<span class="md-ellipsis">
Homepage Dashboard
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/code-server/" class="md-nav__link">
<span class="md-ellipsis">
Code Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/flatnotes/" class="md-nav__link">
<span class="md-ellipsis">
Flatnotes
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/listmonk/" class="md-nav__link">
<span class="md-ellipsis">
Listmonk
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/nocodb/" class="md-nav__link">
<span class="md-ellipsis">
NocoDB
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/mkdocs-material/" class="md-nav__link">
<span class="md-ellipsis">
MkDocs Material
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/excalidraw/" class="md-nav__link">
<span class="md-ellipsis">
Excalidraw
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/gitea/" class="md-nav__link">
<span class="md-ellipsis">
Gitea
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/openwebui/" class="md-nav__link">
<span class="md-ellipsis">
OpenWebUI
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/monica-crm/" class="md-nav__link">
<span class="md-ellipsis">
Monica CRM
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/answer/" class="md-nav__link">
<span class="md-ellipsis">
Answer
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/ferdium/" class="md-nav__link">
<span class="md-ellipsis">
Ferdium
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/rocketchat/" class="md-nav__link">
<span class="md-ellipsis">
Rocket.Chat
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/ollama/" class="md-nav__link">
<span class="md-ellipsis">
Ollama (Local AI)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/portainer/" class="md-nav__link">
<span class="md-ellipsis">
Portainer (Docker UI)
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../apps/n8n/" class="md-nav__link">
<span class="md-ellipsis">
n8n (Workflow Automation)
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Guides
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../guides/authoring-content/" class="md-nav__link">
<span class="md-ellipsis">
Authoring Content
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../guides/ollama-vscode/" class="md-nav__link">
<span class="md-ellipsis">
Using Ollama in VS Code
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../ollama.md" class="md-nav__link">
<span class="md-ellipsis">
Ollama Setup (Legacy)
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="changemaker-v5">Changemaker V5<a class="headerlink" href="#changemaker-v5" title="Permanent link">&para;</a></h1>
<p>Changemaker V5 is a battle-tested, lightweight, self-hosted productivity suite which empowers you to deploy secure, locally-built websites, blogs, newsletters, &amp; forms – from personal projects to full-fledged campaigns – granting you complete control, inherent security, and true freedom of speech. </p>
<p>It is a project undertaken by The Bunker Operations, headquarted in Edmonton, Alberta, Canada, as to provide our community a digital campaign alternative to mainstream American systems. </p>
<hr />
<h2 id="currated-suite-of-applications">Currated Suite of Applications<a class="headerlink" href="#currated-suite-of-applications" title="Permanent link">&para;</a></h2>
<h2 id="_1"><img alt="homepage" src="/assets/images/homepage.png" /><a class="headerlink" href="#_1" title="Permanent link">&para;</a></h2>
<h2 id="contents">Contents<a class="headerlink" href="#contents" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
<li><a href="#quick-start">Quick Start</a></li>
<li><a href="#detailed-installation">Detailed Installation</a></li>
<li><a href="#1-install-docker-and-docker-compose">1. Install Docker and Docker Compose</a></li>
<li><a href="#2-clone-the-repository">2. Clone the Repository</a></li>
<li><a href="#3-configure-your-environment">3. Configure Your Environment</a></li>
<li><a href="#4-start-the-services">4. Start the Services</a></li>
<li><a href="#5-run-post-installation-tasks">5. Run Post-Installation Tasks</a></li>
<li><a href="#local-service-ports">Local Service Ports</a></li>
<li><a href="#cloudflare-tunnel-setup">Cloudflare Tunnel Setup</a></li>
<li><a href="#install-cloudflared-on-ubuntu-2404">Install Cloudflared on Ubuntu 24.04</a></li>
<li><a href="#configure-your-cloudflare-tunnel">Configure Your Cloudflare Tunnel</a></li>
<li><a href="#create-a-cloudflare-system-service">Create a Cloudflare System Service</a></li>
<li><a href="#add-cname-records">Add CNAME Records</a></li>
<li><a href="#reset-your-installation">Reset Your Installation</a></li>
<li><a href="#accessing-your-services">Accessing Your Services</a></li>
<li><a href="#troubleshooting">Troubleshooting</a></li>
</ul>
<hr />
<h2 id="development-pathway">Development Pathway<a class="headerlink" href="#development-pathway" title="Permanent link">&para;</a></h2>
<p>Changemaker's identified wants for development:
- Internal integrations for assset management i.e. shared plain file locations
- Database connections for automation systems i.e. manauls for Nocodb &amp; n8n on connecting services
- Manual &amp; landing site for the whole system i.e. upgrading bnkops.com
- Trainings and manuals across the board </p>
<p>Idenitfied Feature Requests:
- Event Management: Looking at <a href="https://hi.events/">hi.ewvents</a>
- Scheduling: Looking at <a href="https://rallly.co/">rally</a>
- Support and user chat: looking at <a href="https://github.com/chatwoot/chatwoot">chatwoot</a>
- Mass community chat: looking at <a href="https://thelounge.chat/">thelounge</a>
- Team chat and project management: looking at <a href="https://github.com/RocketChat/Rocket.Chat">rocket chat</a> ✔️</p>
<p>Bugs:
- Readme needs a full flow redo - ✅ next up
- Config script needs to be updated for nocodb for a simpler string / set the string - <img alt="✅" class="emojione" src="https://cdnjs.cloudflare.com/ajax/libs/emojione/2.2.7/assets/png/2705.png" title=":white_check_mark:" />
- Gitea DNS application access bypass not properly setting - ✅ bypass needing manual setup / need to explore api more
- Portainer not serving to http - 🟡 still not sure how to fix config
- nocodb setup upping odd - ✅ password needs no special characters
- ferdium port mismatch - ✅ was a cloudflare port setting missmatch</p>
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
<ul>
<li>A Linux server (Ubuntu 22.04/24.04 recommended)</li>
<li>Docker &amp; Docker Compose</li>
<li>Internet connection</li>
<li>(Optional) Root or sudo access</li>
<li>(Optional) A domain name for remote access</li>
<li>(Optional) Cloudflare account for tunnel setup</li>
</ul>
<h2 id="quick-start-for-local-dev">Quick Start for Local Dev<a class="headerlink" href="#quick-start-for-local-dev" title="Permanent link">&para;</a></h2>
<p>Review all off the applications <a href="/apps.md">here</a></p>
<p>If you're familiar with Docker and want to get started quickly:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="c1"># Clone the repository</span>
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a>git<span class="w"> </span>clone<span class="w"> </span>https://gitea.bnkhome.org/bnkops/Changemaker.git
<a id="__codelineno-0-3" name="__codelineno-0-3" href="#__codelineno-0-3"></a><span class="nb">cd</span><span class="w"> </span>changemaker
</code></pre></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="c1"># Use default configuration for development or run the config script for configuration</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="c1"># To optionally configure, first make the script executable:</span>
<a id="__codelineno-1-3" name="__codelineno-1-3" href="#__codelineno-1-3"></a>chmod<span class="w"> </span>+x<span class="w"> </span>config.sh
<a id="__codelineno-1-4" name="__codelineno-1-4" href="#__codelineno-1-4"></a>
<a id="__codelineno-1-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="c1"># Then run the configuration script:</span>
<a id="__codelineno-1-6" name="__codelineno-1-6" href="#__codelineno-1-6"></a>./config.sh
</code></pre></div>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a># Start all services
<a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>docker compose up -d
</code></pre></div>
<p><strong>[!Warning] Configure Portainer &amp; Install Gitea</strong></p>
<p>Portainer has a timed build process. Make sure to immediatly configure the service by visiting https://localhost:9444 </p>
<p>Gitea has a install process that you should complete on first build. </p>
<p><strong>First time installation can take several miniutes</strong></p>
<p>On a 1GB internet connection, instal time is approximately 3 minutes. </p>
<h2 id="local-service-ports">Local Service Ports<a class="headerlink" href="#local-service-ports" title="Permanent link">&para;</a></h2>
<p>When running Changemaker locally, you can access the services at the following ports on your server:</p>
<table>
<thead>
<tr>
<th>Service</th>
<th>Local Port</th>
<th>Local URL</th>
</tr>
</thead>
<tbody>
<tr>
<td>Homepage</td>
<td>3010</td>
<td><a href="http://localhost:3010">http://localhost:3010</a></td>
</tr>
<tr>
<td>Excalidraw</td>
<td>3333</td>
<td><a href="http://localhost:3333">http://localhost:3333</a></td>
</tr>
<tr>
<td>Listmonk</td>
<td>9000</td>
<td><a href="http://localhost:9000">http://localhost:9000</a></td>
</tr>
<tr>
<td>Monica CRM</td>
<td>8085</td>
<td><a href="http://localhost:8085">http://localhost:8085</a></td>
</tr>
<tr>
<td>MkDocs</td>
<td>4000</td>
<td><a href="http://localhost:4000">http://localhost:4000</a></td>
</tr>
<tr>
<td>Flatnotes</td>
<td>8089</td>
<td><a href="http://localhost:8089">http://localhost:8089</a></td>
</tr>
<tr>
<td>Code Server</td>
<td>8888</td>
<td><a href="http://localhost:8888">http://localhost:8888</a></td>
</tr>
<tr>
<td>Ollama</td>
<td>11435</td>
<td><a href="http://localhost:11435">http://localhost:11435</a></td>
</tr>
<tr>
<td>OpenWebUI</td>
<td>3005</td>
<td><a href="http://localhost:3005">http://localhost:3005</a></td>
</tr>
<tr>
<td>Gitea</td>
<td>3030</td>
<td><a href="http://localhost:3030">http://localhost:3030</a></td>
</tr>
<tr>
<td>Portainer</td>
<td>8005</td>
<td><a href="http://localhost:8005">http://localhost:8005</a></td>
</tr>
<tr>
<td>Mini QR</td>
<td>8081</td>
<td><a href="http://localhost:8081">http://localhost:8081</a></td>
</tr>
<tr>
<td>Ferdium</td>
<td>3006</td>
<td><a href="http://localhost:3006">http://localhost:3006</a></td>
</tr>
<tr>
<td>Answer</td>
<td>9080</td>
<td><a href="http://localhost:9080">http://localhost:9080</a></td>
</tr>
<tr>
<td>NocoDB</td>
<td>8090</td>
<td><a href="http://localhost:8090">http://localhost:8090</a></td>
</tr>
<tr>
<td>n8n</td>
<td>5678</td>
<td><a href="https://localhost:5678">https://localhost:5678</a></td>
</tr>
<tr>
<td>ConvertX</td>
<td>3100</td>
<td><a href="http://localhost:3100">http://localhost:3100</a></td>
</tr>
<tr>
<td>Rocket.Chat</td>
<td>3004</td>
<td><a href="http://localhost:3004">http://localhost:3004</a></td>
</tr>
</tbody>
</table>
<h2 id="detailed-installation">Detailed Installation<a class="headerlink" href="#detailed-installation" title="Permanent link">&para;</a></h2>
<h3 id="ubuntu-os-build-outs">Ubuntu OS &amp; Build Outs<a class="headerlink" href="#ubuntu-os-build-outs" title="Permanent link">&para;</a></h3>
<p>You can deploy Changemaker on any OS using Docker however we also provide several full Ubuntu build-outs. These scripts can speed up your deployment immensely and Changemaker is developed on a like system: </p>
<ol>
<li><strong><a href="https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/build.server.md">build.server</a></strong> - this build-out is a lightweight deployment aimed for dedicated server machines. It is focused on entry level users who would build on a dedicated machine. </li>
<li><strong><a href="https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/build.homelab.md">build.homelab</a></strong> - this build-out is full-some development focused build-out that The Bunker Operations uses for our day-to-day operations. </li>
</ol>
<p>Configuration and services scripts for futher developing the system can be found at the <a href="https://gitea.bnkhome.org/bnkops/scripts">scripts</a> repo. </p>
<h3 id="1-install-docker-and-docker-compose">1. Install Docker and Docker Compose<a class="headerlink" href="#1-install-docker-and-docker-compose" title="Permanent link">&para;</a></h3>
<p>Install Docker and Docker Compose on your system if they're not already installed: </p>
<p><a href="https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/build.homelab.md#dockerhttpswwwdockercom">Install Docker &amp; Docker Compose</a></p>
<p>Verify that Docker and Docker Compose are installed correctly:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>docker<span class="w"> </span>--version
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>docker<span class="w"> </span>compose<span class="w"> </span>version
</code></pre></div>
<h3 id="2-clone-the-repository">2. Clone the Repository<a class="headerlink" href="#2-clone-the-repository" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://github.com/your-org/changemaker-v5.git
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a><span class="nb">cd</span><span class="w"> </span>changemaker-v5
</code></pre></div>
<h3 id="2-configure-your-environment">2. Configure Your Environment<a class="headerlink" href="#2-configure-your-environment" title="Permanent link">&para;</a></h3>
<h4 id="setting-up-cloudflare-credentials">Setting Up Cloudflare Credentials<a class="headerlink" href="#setting-up-cloudflare-credentials" title="Permanent link">&para;</a></h4>
<p>To use the script, you'll need to collect several Cloudflare variables: </p>
<ol>
<li><strong>Create an API Token with appropriate permissions</strong>:</li>
<li>Go to your <a href="https://dash.cloudflare.com/">Cloudflare Dashboard</a> → Profile → API Tokens</li>
<li>Click "Create Token"</li>
<li>Either use the "Edit zone DNS" template or create a custom token with:<ul>
<li>Zone:DNS:Edit permissions</li>
<li>Access:Apps:Edit permissions</li>
</ul>
</li>
<li>Restrict the token to only your specific zone/domain</li>
<li>
<p>Generate and copy the token</p>
</li>
<li>
<p><strong>Get your Zone ID</strong>:</p>
</li>
<li>Go to your domain's overview page in the Cloudflare dashboard</li>
<li>The Zone ID is displayed on the right sidebar</li>
<li>
<p>It looks like: <code>023e105f4ecef8ad9ca31a8372d0c353</code></p>
</li>
<li>
<p><strong>Get your Tunnel ID</strong>:</p>
</li>
<li>You should have noted your tunnel id in your tunnel creation or you can find it through cloudflare or in your files: </li>
<li>Go to Cloudflare Zero Trust dashboard → Access → Tunnels</li>
<li>Click on your tunnel</li>
<li>The Tunnel ID is in the URL: <code>https://dash.teams.cloudflare.com/xxx/network/tunnels/xxxx</code></li>
<li>It looks like: <code>6ff42ae2-765d-4adf-8112-31c55c1551ef</code></li>
</ol>
<p>You have two options:</p>
<p><strong>Option A: Use the configuration wizard (recommended)</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># Make the script executable</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>chmod<span class="w"> </span>+x<span class="w"> </span>config.sh
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># Run the configuration wizard</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>./config.sh
</code></pre></div></p>
<p><strong>Option B: Configure manually</strong>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="c1"># Edit the .env file with your settings</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>nano<span class="w"> </span>.env
</code></pre></div></p>
<h3 id="4-start-the-services">4. Start the Services<a class="headerlink" href="#4-start-the-services" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c1"># Pull and start all containers in detached mode</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<blockquote>
<p>[!Warning] Configure Portainer </p>
</blockquote>
<p>Portainer has a timed build process. Make sure to immediatly configure the service at https://localhost:9444 following successful build. </p>
<p>All services can now be accessed through on local machine. If deploying to public, it is recommended to <strong>configure portainer</strong> and then continue configuration for all other services once tunnel is established. Then use the public links for configuration of services. For online deployment with Cloudflare, continue to next steps. </p>
<h3 id="4-cloudflare-tunnel-setup">4. Cloudflare Tunnel Setup<a class="headerlink" href="#4-cloudflare-tunnel-setup" title="Permanent link">&para;</a></h3>
<p>For secure remote access to your services, you can set up a Cloudflare Tunnel.</p>
<h3 id="install-cloudflared-on-ubuntu-2404">Install Cloudflared on Ubuntu 24.04<a class="headerlink" href="#install-cloudflared-on-ubuntu-2404" title="Permanent link">&para;</a></h3>
<p><a href="https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/build.homelab.md#cloudflaredhttpsdeveloperscloudflarecomcloudflare-oneconnectionsconnect-networks">Cloudflared Installation Guide</a></p>
<h3 id="configure-your-cloudflare-tunnel">Configure Your Cloudflare Tunnel<a class="headerlink" href="#configure-your-cloudflare-tunnel" title="Permanent link">&para;</a></h3>
<p>You can use our <a href="https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/config.cloudflare.homelab.md">Cloudflare Configuration Guide</a> however remember to copy the values of the <a href="/example.cloudflare.config.yml">example config</a> for this deployment. </p>
<h3 id="create-a-cloudflare-system-service">Create a Cloudflare System Service<a class="headerlink" href="#create-a-cloudflare-system-service" title="Permanent link">&para;</a></h3>
<p><a href="https://gitea.bnkhome.org/bnkops/scripts/src/branch/main/service.cloudflared.md">Cloudflare Service Setup Guide</a></p>
<h3 id="add-cname-records">Add CNAME Records<a class="headerlink" href="#add-cname-records" title="Permanent link">&para;</a></h3>
<p>After setting up your Cloudflare Tunnel, you need to add CNAME records for your services. You can do this manually in the Cloudflare DNS panel or with using the following script: <code>add-cname-records.sh</code></p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="c1"># Make the script executable</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>chmod<span class="w"> </span>+x<span class="w"> </span>add-cname-records.sh
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a>
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a><span class="c1"># Run the script to add CNAME records</span>
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a>./add-cname-records.sh
</code></pre></div>
<p>This script will add CNAME records for all Changemaker services to your Cloudflare DNS.</p>
<p>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 <code>config.sh</code> process. For example, if you set your root domain to <code>example.com</code> your access rule will allow emails ending with @example.com thorugh. You can update your access settings in the Cloudflare Zero Trust dashboard.</p>
<blockquote>
<p>[!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 <code>add-cname-records.sh</code> will do this automatically however the user is encouraged to familiarize themselves with Cloudflares Zero Trust access system. </p>
</blockquote>
<h2 id="accessing-your-services">Accessing Your Services<a class="headerlink" href="#accessing-your-services" title="Permanent link">&para;</a></h2>
<p>The <strong>Homepage</strong> acts as a central dashboard for all your Changemaker services. You can access it at:</p>
<ul>
<li>Locally: http://localhost:3010 or http://your-server-ip:3010</li>
<li>With Cloudflare: https://homepage.yourdomain.com</li>
</ul>
<p>The Homepage will display links to all your deployed services, making it easy to navigate your Changemaker ecosystem.</p>
<p>After installation and cloudflare deployment you can also access individual services at the following URLs:</p>
<ul>
<li>Homepage: https://homepage.yourdomain.com</li>
<li>Excalidraw: https://excalidraw.yourdomain.com</li>
<li>Listmonk: https://listmonk.yourdomain.com</li>
<li>Monica CRM: https://monica.yourdomain.com</li>
<li>MkDocs: https://yourdomain.com</li>
<li>Flatnotes: https://flatnotes.yourdomain.com</li>
<li>Code Server: https://code-server.yourdomain.com</li>
<li>Ollama: https://ollama.yourdomain.com</li>
<li>OpenWebUI: https://open-web-ui.yourdomain.com</li>
<li>Gitea: https://gitea.yourdomain.com</li>
<li>Portainer: https://portainer.yourdomain.com</li>
<li>Mini QR: https://mini-qr.yourdomain.com</li>
<li>Ferdium: https://ferdium.yourdomain.com</li>
<li>Answer: https://answer.yourdomain.com</li>
<li>NocoDB: https://nocodb.yourdomain.com</li>
<li>n8n: https://n8n.yourdomain.com</li>
<li>ConvertX: https://convertx.yourdomain.com</li>
<li>Rocket.Chat: https://rocket.yourdomain.com</li>
</ul>
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>
<p>If you encounter issues:</p>
<ol>
<li>
<p>Check the Docker logs:
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>logs
</code></pre></div></p>
</li>
<li>
<p>Verify service status:
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>ps
</code></pre></div></p>
</li>
<li>
<p>Ensure your Cloudflare Tunnel is running:
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>sudo<span class="w"> </span>systemctl<span class="w"> </span>status<span class="w"> </span>cloudflared
</code></pre></div></p>
</li>
<li>
<p>Check CNAME records in your Cloudflare dashboard.</p>
</li>
</ol>
<p>For additional help, please file an issue on our GitHub repository.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2024 The Bunker Operations - Built with Change Maker
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.sections", "navigation.tracking", "navigation.indexes", "navigation.collapse", "toc.integrate", "content.code.copy", "navigation.top", "navigation.tabs"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink