admin/Changemaker
1
0
Fork 0
Code Issues 2 Packages Projects Releases Wiki Activity

Site remake.

Browse Source
This commit is contained in:
admin
2025-05-13 16:01:54 -06:00
parent 3131304bca
commit 6510c75216
39 changed files with 1080 additions and 3177 deletions
Download Patch File Download Diff File Expand all files Collapse all files

515
mkdocs/site/readme/index.html
View File

@@ -15,10 +15,6 @@
<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">
@@ -26,7 +22,7 @@
<title>About Changemaker - Changemaker Documentation</title>
<title>Changemaker V5 - Changemaker Documentation</title>
@@ -65,7 +61,7 @@
<meta property="og:type" content="website" >
<meta property="og:title" content="About Changemaker - Changemaker Documentation" >
<meta property="og:title" content="Changemaker V5 - Changemaker Documentation" >
<meta property="og:description" content="Demo site for Changemaker" >
@@ -81,7 +77,7 @@
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="About Changemaker - Changemaker Documentation" >
<meta name="twitter:title" content="Changemaker V5 - Changemaker Documentation" >
<meta name="twitter:description" content="Demo site for Changemaker" >
@@ -118,7 +114,7 @@
<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>
Changemkaer Archive. <a href="https://changemaker.bnkops.com">Learn more</a>
</div>
@@ -151,7 +147,7 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
About Changemaker
Changemaker V5
</span>
</div>
@@ -241,46 +237,6 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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>
@@ -401,293 +357,6 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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>
@@ -740,10 +409,10 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_4" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
@@ -756,8 +425,8 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Applications
</label>
@@ -775,7 +444,7 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<span class="md-ellipsis">
Test
Overview
</span>
@@ -1187,10 +856,10 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_5" >
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
@@ -1203,8 +872,8 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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">
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Guides
</label>
@@ -1302,11 +971,11 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<h1 id="changemaker-v5">Changemaker V5<a class="headerlink" href="#changemaker-v5" title="Permanent link">&para;</a></h1>
<p><img alt="changemakergif" src="/assets/images/changemkaerv5.gif" /></p>
<hr />
<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>
<p><img alt="build your power" src="/assets/images/buildyourpower.png" /></p>
<h2 id="contents">Contents<a class="headerlink" href="#contents" title="Permanent link">&para;</a></h2>
<ul>
<li><a href="#prerequisites">Prerequisites</a></li>
@@ -1323,30 +992,37 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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="#website-build-and-deployment-workflow">Website Build and Deployment Workflow</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>
<p>Changemaker's identified wants for development: </p>
<ul>
<li>Internal integrations for assset management i.e. shared plain file locations </li>
<li>Database connections for automation systems i.e. manauls for Nocodb &amp; n8n on connecting services</li>
<li>Manual &amp; landing site for the whole system i.e. upgrading bnkops.com </li>
<li>Trainings and manuals across the board </li>
</ul>
<p>Idenitfied Feature Requests: </p>
<ul>
<li>Event Management: Looking at <a href="https://hi.events/">hi.ewvents</a></li>
<li>Scheduling: Looking at <a href="https://rallly.co/">rally</a></li>
<li>Support and user chat: looking at <a href="https://github.com/chatwoot/chatwoot">chatwoot</a></li>
<li>Mass community chat: looking at <a href="https://thelounge.chat/">thelounge</a></li>
<li>Team chat and project management: looking at <a href="https://github.com/RocketChat/Rocket.Chat">rocket chat</a> ✔️</li>
</ul>
<p>Bugs:</p>
<ul>
<li>Readme needs a full flow redo - ✅ next up </li>
<li>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:" /></li>
<li>Gitea DNS application access bypass not properly setting - ✅ bypass needing manual setup / need to explore api more</li>
<li>Portainer not serving to http - 🤔 portainer to be limited to local access </li>
<li>nocodb setup upping odd - ✅ password needs no special characters</li>
<li>ferdium port mismatch - ✅ was a cloudflare port setting missmatch</li>
</ul>
<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>
@@ -1363,21 +1039,25 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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>
<p>See <a href="#setting-up-cloudflare-credentials">Setting Up Cloudflare Credentials</a> for how to get cloudflare credentials for config.sh.</p>
<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 local development.</span>
<a id="__codelineno-1-2" name="__codelineno-1-2" href="#__codelineno-1-2"></a><span class="c1"># To configure for remote deployment with Cloudflare, 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-5" name="__codelineno-1-5" href="#__codelineno-1-5"></a><span class="c1"># Then run the configuration script. You will need your Cloudflare details.</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>
<p>On a 1GB internet connection, instal time is approximately 5 minutes.</p>
<h3 id="configure-portainer-immediately">⚠️ Configure Portainer Immediately 🦊<a class="headerlink" href="#configure-portainer-immediately" title="Permanent link">&para;</a></h3>
<p>Portainer has a timed build process that needs to be completed on successful build. Proceed to configure the service by visiting https://localhost:9444 </p>
<p>Gitea has a install process that you should complete immediately after connecting system to dns and domain services. </p>
<h3 id="on-successful-build-vist-local-homepage">On Successful Build, Vist <a href="http://localhost:3011">Local Homepage</a><a class="headerlink" href="#on-successful-build-vist-local-homepage" title="Permanent link">&para;</a></h3>
<p>The <a href="http://localhost:3011">local homepage - http://localhost:3011</a> is configured with all of the services you can access securely locally. </p>
<p>To access services outside of network, configure a VPN, Tailscale, or continue to Cloudflare publishing documentation.</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>
@@ -1390,6 +1070,16 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
</thead>
<tbody>
<tr>
<td>Root/Website (Nginx)</td>
<td>4001</td>
<td><a href="http://localhost:4001">http://localhost:4001</a></td>
</tr>
<tr>
<td>Homepage (local)</td>
<td>3011</td>
<td><a href="http://localhost:3011">http://locahost:3011</a></td>
</tr>
<tr>
<td>Homepage</td>
<td>3010</td>
<td><a href="http://localhost:3010">http://localhost:3010</a></td>
@@ -1442,7 +1132,7 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<tr>
<td>Portainer</td>
<td>8005</td>
<td><a href="http://localhost:8005">http://localhost:8005</a></td>
<td><a href="https://localhost:9444">https://localhost:9444</a></td>
</tr>
<tr>
<td>Mini QR</td>
@@ -1451,8 +1141,8 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
</tr>
<tr>
<td>Ferdium</td>
<td>3006</td>
<td><a href="http://localhost:3006">http://localhost:3006</a></td>
<td>3009</td>
<td><a href="http://localhost:3009">http://localhost:3009</a></td>
</tr>
<tr>
<td>Answer</td>
@@ -1467,7 +1157,7 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<tr>
<td>n8n</td>
<td>5678</td>
<td><a href="https://localhost:5678">https://localhost:5678</a></td>
<td><a href="http://localhost:5678">http://localhost:5678</a></td>
</tr>
<tr>
<td>ConvertX</td>
@@ -1481,7 +1171,6 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
</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>
@@ -1504,8 +1193,12 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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>
<p><strong>Create an API Token with appropriate permissions</strong>:</p>
</li>
<li>
<p>Go to your <a href="https://dash.cloudflare.com/">Cloudflare Dashboard</a> → Profile → API Tokens</p>
</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>
@@ -1519,7 +1212,9 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<li>
<p><strong>Get your Zone ID</strong>:</p>
</li>
<li>Go to your domain's overview page in the Cloudflare dashboard</li>
<li>
<p>Go to your domain's overview page in the Cloudflare dashboard</p>
</li>
<li>The Zone ID is displayed on the right sidebar</li>
<li>
<p>It looks like: <code>023e105f4ecef8ad9ca31a8372d0c353</code></p>
@@ -1527,20 +1222,22 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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>
<p>You should have noted your tunnel id in your tunnel creation or you can find it through cloudflare or in your files: </p>
</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>
<p><strong>Option A: Use the configuration wizard (recommended)</strong></p>
<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>
</code></pre></div>
<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
@@ -1573,19 +1270,57 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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>
<p>[!warning] ⚠️ Cloudflare Zero Trust ⚠️</p>
</blockquote>
<p>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>
<h2 id="website-build-and-deployment-workflow">Website Build and Deployment Workflow<a class="headerlink" href="#website-build-and-deployment-workflow" title="Permanent link">&para;</a></h2>
<p>Changemaker uses MkDocs to create your website content, which is then served by an Nginx server. To update your website, you need to:</p>
<ol>
<li><strong>Edit your content</strong> using either the Code Server or locally on your machine</li>
<li><strong>Build the static site files</strong> </li>
<li><strong>Let the Nginx server (mkdocs-site-server) serve the built site</strong></li>
</ol>
<h3 id="building-your-website">Building Your Website<a class="headerlink" href="#building-your-website" title="Permanent link">&para;</a></h3>
<p>You can build your website in two ways:</p>
<h4 id="option-1-using-code-server-recommended-for-remote-deployments">Option 1: Using Code Server (recommended for remote deployments)<a class="headerlink" href="#option-1-using-code-server-recommended-for-remote-deployments" title="Permanent link">&para;</a></h4>
<ol>
<li>Access Code Server at http://localhost:8888 or https://code-server.yourdomain.com</li>
<li>Navigate to the mkdocs directory <code>/home/coder/mkdocs/</code></li>
<li>Open a terminal in Code Server</li>
<li>Run the build command:
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nb">cd</span><span class="w"> </span>/home/coder/mkdocs
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a>mkdocs<span class="w"> </span>build
</code></pre></div></li>
</ol>
<h4 id="option-2-locally-on-your-machine">Option 2: Locally on your machine<a class="headerlink" href="#option-2-locally-on-your-machine" title="Permanent link">&para;</a></h4>
<ol>
<li>Navigate to the mkdocs directory in your project:
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="nb">cd</span><span class="w"> </span>/home/bunker-admin/Changemaker/mkdocs
</code></pre></div></li>
<li>Run the build command:
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>mkdocs<span class="w"> </span>build
</code></pre></div></li>
</ol>
<p>After building, the static site files will be generated in the <code>mkdocs/site</code> directory, which is automatically mounted to the Nginx server (mkdocs-site-server). Your website will be immediately available at:
- Locally: http://localhost:4001
- With Cloudflare: https://yourdomain.com</p>
<h3 id="development-vs-production">Development vs Production<a class="headerlink" href="#development-vs-production" title="Permanent link">&para;</a></h3>
<ul>
<li>During <strong>development</strong>, you can use the MkDocs live server at port 4000, which automatically rebuilds when you make changes</li>
<li>For <strong>production</strong>, build your site as described above and let the Nginx server at port 4001 serve the static files</li>
</ul>
<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>Locally: http://localhost:3011 or http://your-server-ip:3011</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>Website: https://yourdomain.com</li>
<li>Homepage: https://homepage.yourdomain.com</li>
<li>Live Preview: https://live.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>
@@ -1609,17 +1344,17 @@ This is a demo site for Change Maker. <a href="https://changemaker.bnkops.com">L
<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
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-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
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-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
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a>sudo<span class="w"> </span>systemctl<span class="w"> </span>status<span class="w"> </span>cloudflared
</code></pre></div></p>
</li>
<li>