1 line
188 KiB
JSON
1 line
188 KiB
JSON
{"config":{"lang":["en"],"separator":"[\\s\\u200b\\-_,:!=\\[\\]()\"`/]+|\\.(?!\\d)|&[lg]t;|(?!\\b)(?=[A-Z][a-z])","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Welcome to Changemaker Lite","text":"<p>Stop feeding your secrets to corporations. Own your political infrastructure.</p>"},{"location":"#quick-start","title":"Quick Start","text":"<p>Get up and running in minutes:</p> <pre><code># Clone the repository\ngit clone https://gitea.bnkops.com/admin/changemaker.lite\ncd changemaker.lite\n\n# Configure environment\n./config.sh\n\n# Start all services\ndocker compose up -d\n\n# For production deployment with Cloudflare tunnels\n./start-production.sh\n</code></pre>"},{"location":"#services","title":"Services","text":"<p>Changemaker Lite includes these essential services:</p>"},{"location":"#core-services","title":"Core Services","text":"<ul> <li>Homepage (Port 3010) - Central dashboard and service monitoring</li> <li>Code Server (Port 8888) - VS Code in your browser</li> <li>MkDocs (Port 4000) - Documentation with live preview </li> <li>Static Server (Port 4001) - Production documentation site</li> </ul>"},{"location":"#communication-automation","title":"Communication & Automation","text":"<ul> <li>Listmonk (Port 9000) - Newsletter and email campaign management</li> <li>n8n (Port 5678) - Workflow automation platform</li> </ul>"},{"location":"#data-development","title":"Data & Development","text":"<ul> <li>NocoDB (Port 8090) - No-code database platform</li> <li>PostgreSQL (Port 5432) - Database backend for Listmonk</li> <li>Gitea (Port 3030) - Self-hosted Git service</li> </ul>"},{"location":"#interactive-tools","title":"Interactive Tools","text":"<ul> <li>Map Viewer (Port 3000) - Interactive map with NocoDB integration</li> <li>Mini QR (Port 8089) - QR code generator</li> </ul>"},{"location":"#getting-started","title":"Getting Started","text":"<ol> <li>Setup: Run <code>./config.sh</code> to configure your environment</li> <li>Launch: Start services with <code>docker compose up -d</code></li> <li>Dashboard: Access the Homepage at http://localhost:3010</li> <li>Production: Deploy with Cloudflare tunnels using <code>./start-production.sh</code></li> </ol>"},{"location":"#project-structure","title":"Project Structure","text":"<pre><code>changemaker.lite/\n\u251c\u2500\u2500 docker-compose.yml # Service definitions\n\u251c\u2500\u2500 config.sh # Configuration wizard\n\u251c\u2500\u2500 start-production.sh # Production deployment script\n\u251c\u2500\u2500 mkdocs/ # Documentation source\n\u2502 \u251c\u2500\u2500 docs/ # Markdown files\n\u2502 \u2514\u2500\u2500 mkdocs.yml # MkDocs configuration\n\u251c\u2500\u2500 configs/ # Service configurations\n\u2502 \u251c\u2500\u2500 homepage/ # Homepage dashboard config\n\u2502 \u251c\u2500\u2500 code-server/ # VS Code settings\n\u2502 \u2514\u2500\u2500 cloudflare/ # Tunnel configurations\n\u251c\u2500\u2500 map/ # Map application\n\u2502 \u251c\u2500\u2500 app/ # Node.js application\n\u2502 \u251c\u2500\u2500 Dockerfile # Container definition\n\u2502 \u2514\u2500\u2500 .env # Map configuration\n\u2514\u2500\u2500 assets/ # Shared assets\n \u251c\u2500\u2500 images/ # Image files\n \u251c\u2500\u2500 icons/ # Service icons\n \u2514\u2500\u2500 uploads/ # Listmonk uploads\n</code></pre>"},{"location":"#key-features","title":"Key Features","text":"<ul> <li>\ud83d\udc33 Fully Containerized - All services run in Docker containers</li> <li>\ud83d\udd12 Production Ready - Built-in Cloudflare tunnel support for secure access</li> <li>\ud83d\udce6 All-in-One - Everything you need for documentation, development, and campaigns</li> <li>\ud83d\uddfa\ufe0f Geographic Data - Interactive maps with real-time location tracking</li> <li>\ud83d\udce7 Email Campaigns - Professional newsletter management</li> <li>\ud83d\udd04 Automation - Connect services and automate workflows</li> <li>\ud83d\udcbe Version Control - Self-hosted Git repository</li> <li>\ud83c\udfaf No-Code Database - Build applications without programming</li> </ul>"},{"location":"#system-requirements","title":"System Requirements","text":"<ul> <li>OS: Ubuntu 24.04 LTS (Noble Numbat) or compatible Linux distribution</li> <li>Docker: Version 24.0+ with Docker Compose v2</li> <li>Memory: Minimum 4GB RAM (8GB recommended)</li> <li>Storage: 20GB+ available disk space</li> <li>Network: Internet connection for initial setup</li> </ul>"},{"location":"#learn-more","title":"Learn More","text":"<ul> <li>Getting Started - Detailed installation guide</li> <li>Services Overview - Deep dive into each service</li> <li>Blog - Updates and tutorials</li> <li>GitHub Repository - Source code</li> </ul>"},{"location":"test/","title":"Test","text":"<p>lololol </p> <p>okay well just doing some fast writing because why the heck not. </p> <p>\"I would ask for an apology from the city (Municipality of Jasper) as a result,\"</p> <p>lololol</p>"},{"location":"adv/","title":"Advanced Configurations","text":"<p>We are also publishing how BNKops does several advanced workflows. These include things like assembling hardware, how to manage a network, how to manage several changemakers simultaneously, and integrating AI. </p>"},{"location":"adv/ansible/","title":"Setting Up Ansible with Tailscale for Remote Server Management","text":""},{"location":"adv/ansible/#overview","title":"Overview","text":"<p>This guide walks you through setting up Ansible to manage remote servers (like ThinkCentre units) using Tailscale for secure networking. This approach provides reliable remote access without complex port forwarding or VPN configurations.</p> <p>In plainer language; this allows you to manage several Changemaker nodes remotely. If you are a full time campaigner, this can enable you to manage several campaigns infrastructure from a central location while each user gets their own Changemaker box. </p>"},{"location":"adv/ansible/#what-youll-learn","title":"What You'll Learn","text":"<ul> <li>How to set up Ansible for infrastructure automation</li> <li>How to configure secure remote access using Tailscale</li> <li>How to troubleshoot common SSH and networking issues</li> <li>Why this approach is better than alternatives like Cloudflare Tunnels for simple SSH access</li> </ul>"},{"location":"adv/ansible/#prerequisites","title":"Prerequisites","text":"<ul> <li>Master Node: Your main computer running Ubuntu/Linux (control machine)</li> <li>Target Nodes: Remote servers/ThinkCentres running Ubuntu/Linux</li> <li>Both machines: Must have internet access</li> <li>User Account: Same username on all machines (recommended)</li> </ul>"},{"location":"adv/ansible/#part-1-initial-setup-on-master-node","title":"Part 1: Initial Setup on Master Node","text":""},{"location":"adv/ansible/#1-create-ansible-directory-structure","title":"1. Create Ansible Directory Structure","text":"<pre><code># Create project directory\nmkdir ~/ansible_quickstart\ncd ~/ansible_quickstart\n\n# Create directory structure\nmkdir -p group_vars host_vars roles playbooks\n</code></pre>"},{"location":"adv/ansible/#2-install-ansible","title":"2. Install Ansible","text":"<pre><code>sudo apt update\nsudo apt install ansible\n</code></pre>"},{"location":"adv/ansible/#3-generate-ssh-keys-if-not-already-done","title":"3. Generate SSH Keys (if not already done)","text":"<pre><code># Generate SSH key pair\nssh-keygen -t rsa -b 4096 -f ~/.ssh/id_rsa\n\n# Display public key (save this for later)\ncat ~/.ssh/id_rsa.pub\n</code></pre>"},{"location":"adv/ansible/#part-2-target-node-setup-physical-access-required-initially","title":"Part 2: Target Node Setup (Physical Access Required Initially)","text":""},{"location":"adv/ansible/#1-enable-ssh-on-target-node","title":"1. Enable SSH on Target Node","text":"<p>Access each target node physically (monitor + keyboard):</p> <pre><code># Update system\nsudo apt update && sudo apt upgrade -y\n\n# Install and enable SSH\nsudo apt install openssh-server\nsudo systemctl enable ssh\nsudo systemctl start ssh\n\n# Check SSH status\nsudo systemctl status ssh\n</code></pre> <p>Note: If you get \"Unit ssh.service could not be found\", you need to install the SSH server first:</p> <pre><code># Install OpenSSH server\nsudo apt install openssh-server\n\n# Then start and enable SSH\nsudo systemctl start ssh\nsudo systemctl enable ssh\n\n# Verify SSH is running and listening\nsudo ss -tlnp | grep :22\n</code></pre> <p>You should see SSH listening on port 22.</p>"},{"location":"adv/ansible/#2-configure-ssh-key-authentication","title":"2. Configure SSH Key Authentication","text":"<pre><code># Create .ssh directory\nmkdir -p ~/.ssh\nchmod 700 ~/.ssh\n\n# Create authorized_keys file\nnano ~/.ssh/authorized_keys\n</code></pre> <p>Paste your public key from the master node, then:</p> <pre><code># Set proper permissions\nchmod 600 ~/.ssh/authorized_keys\n</code></pre>"},{"location":"adv/ansible/#3-configure-ssh-security","title":"3. Configure SSH Security","text":"<pre><code># Edit SSH config\nsudo nano /etc/ssh/sshd_config\n</code></pre> <p>Ensure these lines are uncommented:</p> <pre><code>PubkeyAuthentication yes\nAuthorizedKeysFile .ssh/authorized_keys .ssh/authorized_keys2\n</code></pre> <pre><code># Restart SSH service\nsudo systemctl restart ssh\n</code></pre>"},{"location":"adv/ansible/#4-configure-firewall","title":"4. Configure Firewall","text":"<pre><code># Check firewall status\nsudo ufw status\n\n# Allow SSH through firewall\nsudo ufw allow ssh\n\n# Fix home directory permissions (required for SSH keys)\nchmod 755 ~/\n</code></pre>"},{"location":"adv/ansible/#part-3-test-local-ssh-connection","title":"Part 3: Test Local SSH Connection","text":"<p>Before proceeding with remote access, test SSH connectivity locally:</p> <pre><code># From master node, test SSH to target\nssh username@<target-local-ip>\n</code></pre> <p>Common Issues and Solutions:</p> <ul> <li>Connection hangs: Check firewall rules (<code>sudo ufw allow ssh</code>)</li> <li>Permission denied: Verify SSH keys and file permissions</li> <li>SSH config errors: Ensure <code>PubkeyAuthentication yes</code> is set</li> </ul>"},{"location":"adv/ansible/#part-4-set-up-tailscale-for-remote-access","title":"Part 4: Set Up Tailscale for Remote Access","text":""},{"location":"adv/ansible/#why-tailscale-over-alternatives","title":"Why Tailscale Over Alternatives","text":"<p>We initially tried Cloudflare Tunnels but encountered complexity with:</p> <ul> <li>DNS routing issues</li> <li>Complex configuration for SSH</li> <li>Same-network testing problems</li> <li>Multiple configuration approaches with varying success</li> </ul> <p>Tailscale is superior because:</p> <ul> <li>Zero configuration mesh networking</li> <li>Works from any network</li> <li>Persistent IP addresses</li> <li>No port forwarding needed</li> <li>Free for personal use</li> </ul>"},{"location":"adv/ansible/#1-install-tailscale-on-master-node","title":"1. Install Tailscale on Master Node","text":"<pre><code># Install Tailscale\ncurl -fsSL https://tailscale.com/install.sh | sh\n\n# Connect to Tailscale network\nsudo tailscale up\n</code></pre> <p>Follow the authentication URL to connect with your Google/Microsoft/GitHub account.</p>"},{"location":"adv/ansible/#2-install-tailscale-on-target-nodes","title":"2. Install Tailscale on Target Nodes","text":"<p>On each target node:</p> <pre><code># Install Tailscale\ncurl -fsSL https://tailscale.com/install.sh | sh\n\n# Connect to Tailscale network\nsudo tailscale up\n</code></pre> <p>Authenticate each device through the provided URL.</p>"},{"location":"adv/ansible/#3-get-tailscale-ip-addresses","title":"3. Get Tailscale IP Addresses","text":"<p>On each machine:</p> <pre><code># Get your Tailscale IP\ntailscale ip -4\n</code></pre> <p>Each device receives a persistent IP like <code>100.x.x.x</code>.</p>"},{"location":"adv/ansible/#part-5-configure-ansible","title":"Part 5: Configure Ansible","text":""},{"location":"adv/ansible/#1-create-inventory-file","title":"1. Create Inventory File","text":"<pre><code># Create inventory.ini\ncd ~/ansible_quickstart\nnano inventory.ini\n</code></pre> <p>Content:</p> <pre><code>[thinkcenter]\ntc-node1 ansible_host=100.x.x.x ansible_user=your-username\ntc-node2 ansible_host=100.x.x.x ansible_user=your-username\n\n[all:vars]\nansible_ssh_private_key_file=~/.ssh/id_rsa\nansible_host_key_checking=False\n</code></pre> <p>Replace:</p> <ul> <li><code>100.x.x.x</code> with actual Tailscale IPs</li> <li><code>your-username</code> with your actual username</li> </ul>"},{"location":"adv/ansible/#2-test-ansible-connectivity","title":"2. Test Ansible Connectivity","text":"<pre><code># Test connection to all nodes\nansible all -i inventory.ini -m ping\n</code></pre> <p>Expected output:</p> <pre><code>tc-node1 | SUCCESS => {\n \"changed\": false,\n \"ping\": \"pong\"\n}\n</code></pre>"},{"location":"adv/ansible/#part-6-create-and-run-playbooks","title":"Part 6: Create and Run Playbooks","text":""},{"location":"adv/ansible/#1-simple-information-gathering-playbook","title":"1. Simple Information Gathering Playbook","text":"<pre><code>mkdir -p playbooks\nnano playbooks/info-playbook.yml\n</code></pre> <p>Content:</p> <pre><code>---\n- name: Gather Node Information\n hosts: all\n tasks:\n - name: Get system information\n setup:\n\n - name: Display basic system info\n debug:\n msg: |\n Hostname: {{ ansible_hostname }}\n Operating System: {{ ansible_distribution }} {{ ansible_distribution_version }}\n Architecture: {{ ansible_architecture }}\n Memory: {{ ansible_memtotal_mb }}MB\n CPU Cores: {{ ansible_processor_vcpus }}\n\n - name: Show disk usage\n command: df -h /\n register: disk_info\n\n - name: Display disk usage\n debug:\n msg: \"Root filesystem usage: {{ disk_info.stdout_lines[1] }}\"\n\n - name: Check uptime\n command: uptime\n register: uptime_info\n\n - name: Display uptime\n debug:\n msg: \"System uptime: {{ uptime_info.stdout }}\"\n</code></pre>"},{"location":"adv/ansible/#2-run-the-playbook","title":"2. Run the Playbook","text":"<pre><code>ansible-playbook -i inventory.ini playbooks/info-playbook.yml\n</code></pre>"},{"location":"adv/ansible/#part-7-advanced-playbook-example","title":"Part 7: Advanced Playbook Example","text":""},{"location":"adv/ansible/#system-setup-playbook","title":"System Setup Playbook","text":"<pre><code>nano playbooks/setup-node.yml\n</code></pre> <p>Content:</p> <pre><code>---\n- name: Setup ThinkCentre Node\n hosts: all\n become: yes\n tasks:\n - name: Update package cache\n apt:\n update_cache: yes\n\n - name: Install essential packages\n package:\n name:\n - htop\n - vim\n - curl\n - git\n - docker.io\n state: present\n\n - name: Add user to docker group\n user:\n name: \"{{ ansible_user }}\"\n groups: docker\n append: yes\n\n - name: Create management directory\n file:\n path: /opt/management\n state: directory\n owner: \"{{ ansible_user }}\"\n group: \"{{ ansible_user }}\"\n</code></pre>"},{"location":"adv/ansible/#troubleshooting-guide","title":"Troubleshooting Guide","text":""},{"location":"adv/ansible/#ssh-issues","title":"SSH Issues","text":"<p>Problem: SSH connection hangs</p> <ul> <li>Check firewall: <code>sudo ufw status</code> and <code>sudo ufw allow ssh</code></li> <li>Verify SSH service: <code>sudo systemctl status ssh</code></li> <li>Test local connectivity first</li> </ul> <p>Problem: Permission denied (publickey)</p> <ul> <li>Check SSH key permissions: <code>chmod 600 ~/.ssh/authorized_keys</code></li> <li>Verify home directory permissions: <code>chmod 755 ~/</code></li> <li>Ensure SSH config allows key auth: <code>PubkeyAuthentication yes</code></li> </ul> <p>Problem: Bad owner or permissions on SSH config</p> <pre><code>chmod 600 ~/.ssh/config\n</code></pre>"},{"location":"adv/ansible/#ansible-issues","title":"Ansible Issues","text":"<p>Problem: Host key verification failed</p> <ul> <li>Add to inventory: <code>ansible_host_key_checking=False</code></li> </ul> <p>Problem: Ansible command not found</p> <pre><code>sudo apt install ansible\n</code></pre> <p>Problem: Connection timeouts</p> <ul> <li>Verify Tailscale connectivity: <code>ping <tailscale-ip></code></li> <li>Check if both nodes are connected: <code>tailscale status</code></li> </ul>"},{"location":"adv/ansible/#tailscale-issues","title":"Tailscale Issues","text":"<p>Problem: Can't connect to Tailscale IP</p> <ul> <li>Verify both devices are authenticated: <code>tailscale status</code></li> <li>Check Tailscale is running: <code>sudo systemctl status tailscaled</code></li> <li>Restart Tailscale: <code>sudo tailscale up</code></li> </ul>"},{"location":"adv/ansible/#scaling-to-multiple-nodes","title":"Scaling to Multiple Nodes","text":""},{"location":"adv/ansible/#adding-new-nodes","title":"Adding New Nodes","text":"<ol> <li>Install Tailscale on new node</li> <li>Set up SSH access (repeat Part 2)</li> <li>Add to inventory.ini:</li> </ol> <pre><code>[thinkcenter]\ntc-node1 ansible_host=100.125.148.60 ansible_user=bunker-admin\ntc-node2 ansible_host=100.x.x.x ansible_user=bunker-admin\ntc-node3 ansible_host=100.x.x.x ansible_user=bunker-admin\n</code></pre>"},{"location":"adv/ansible/#group-management","title":"Group Management","text":"<pre><code>[webservers]\ntc-node1 ansible_host=100.x.x.x ansible_user=bunker-admin\ntc-node2 ansible_host=100.x.x.x ansible_user=bunker-admin\n\n[databases]\ntc-node3 ansible_host=100.x.x.x ansible_user=bunker-admin\n\n[all:vars]\nansible_ssh_private_key_file=~/.ssh/id_rsa\nansible_host_key_checking=False\n</code></pre> <p>Run playbooks on specific groups:</p> <pre><code>ansible-playbook -i inventory.ini -l webservers playbook.yml\n</code></pre>"},{"location":"adv/ansible/#best-practices","title":"Best Practices","text":""},{"location":"adv/ansible/#security","title":"Security","text":"<ul> <li>Use SSH keys, not passwords</li> <li>Keep Tailscale client updated</li> <li>Regular security updates via Ansible</li> <li>Use <code>become: yes</code> only when necessary</li> </ul>"},{"location":"adv/ansible/#organization","title":"Organization","text":"<pre><code>ansible_quickstart/\n\u251c\u2500\u2500 inventory.ini\n\u251c\u2500\u2500 group_vars/\n\u251c\u2500\u2500 host_vars/\n\u251c\u2500\u2500 roles/\n\u2514\u2500\u2500 playbooks/\n \u251c\u2500\u2500 info-playbook.yml\n \u251c\u2500\u2500 setup-node.yml\n \u2514\u2500\u2500 maintenance.yml\n</code></pre>"},{"location":"adv/ansible/#monitoring-and-maintenance","title":"Monitoring and Maintenance","text":"<p>Create regular maintenance playbooks:</p> <pre><code>- name: System maintenance\n hosts: all\n become: yes\n tasks:\n - name: Update all packages\n apt:\n upgrade: dist\n update_cache: yes\n\n - name: Clean package cache\n apt:\n autoclean: yes\n autoremove: yes\n</code></pre>"},{"location":"adv/ansible/#alternative-approaches-we-considered","title":"Alternative Approaches We Considered","text":""},{"location":"adv/ansible/#cloudflare-tunnels","title":"Cloudflare Tunnels","text":"<ul> <li>Pros: Good for web services, handles NAT traversal</li> <li>Cons: Complex SSH setup, DNS routing issues, same-network problems</li> <li>Use case: Better for web applications than SSH access</li> </ul>"},{"location":"adv/ansible/#traditional-vpn","title":"Traditional VPN","text":"<ul> <li>Pros: Full network access</li> <li>Cons: Complex setup, port forwarding required, router configuration</li> <li>Use case: When you control the network infrastructure</li> </ul>"},{"location":"adv/ansible/#ssh-reverse-tunnels","title":"SSH Reverse Tunnels","text":"<ul> <li>Pros: Simple concept</li> <li>Cons: Requires VPS, single point of failure, manual setup</li> <li>Use case: Temporary access or when other methods fail</li> </ul>"},{"location":"adv/ansible/#conclusion","title":"Conclusion","text":"<p>This setup provides:</p> <ul> <li>Reliable remote access from anywhere</li> <li>Secure mesh networking with Tailscale</li> <li>Infrastructure automation with Ansible</li> <li>Easy scaling to multiple nodes</li> <li>No complex networking required</li> </ul> <p>The combination of Ansible + Tailscale is ideal for managing distributed infrastructure without the complexity of traditional VPN setups or the limitations of cloud-specific solutions.</p>"},{"location":"adv/ansible/#quick-reference-commands","title":"Quick Reference Commands","text":"<pre><code># Check Tailscale status\ntailscale status\n\n# Test Ansible connectivity\nansible all -i inventory.ini -m ping\n\n# Run playbook on all hosts\nansible-playbook -i inventory.ini playbook.yml\n\n# Run playbook on specific group\nansible-playbook -i inventory.ini -l groupname playbook.yml\n\n# Run single command on all hosts\nansible all -i inventory.ini -m command -a \"uptime\"\n\n# SSH to node via Tailscale\nssh username@100.x.x.x\n</code></pre>"},{"location":"adv/vscode-ssh/","title":"Remote Development with VSCode over Tailscale","text":""},{"location":"adv/vscode-ssh/#overview","title":"Overview","text":"<p>This guide describes how to set up Visual Studio Code for remote development on servers using the Tailscale network. This enables development directly on remote machines as if they were local, with full access to files, terminals, and debugging capabilities.</p>"},{"location":"adv/vscode-ssh/#what-youll-learn","title":"What You'll Learn","text":"<ul> <li>How to configure VSCode for remote SSH connections</li> <li>How to set up remote development environments</li> <li>How to manage multiple remote servers efficiently</li> <li>How to troubleshoot common remote development issues</li> <li>Best practices for remote development workflows</li> </ul>"},{"location":"adv/vscode-ssh/#prerequisites","title":"Prerequisites","text":"<ul> <li>Ansible + Tailscale setup completed (see previous guide)</li> <li>VSCode installed on the local machine (master node)</li> <li>Working SSH access to remote servers via Tailscale</li> <li>Tailscale running on both local and remote machines</li> </ul>"},{"location":"adv/vscode-ssh/#verify-prerequisites","title":"Verify Prerequisites","text":"<p>Before starting, verify the setup:</p> <pre><code># Check Tailscale connectivity\ntailscale status\n\n# Test SSH access\nssh <username>@<tailscale-ip>\n\n# Check VSCode is installed\ncode --version\n</code></pre>"},{"location":"adv/vscode-ssh/#part-1-install-and-configure-remote-ssh-extension","title":"Part 1: Install and Configure Remote-SSH Extension","text":""},{"location":"adv/vscode-ssh/#1-install-the-remote-development-extensions","title":"1. Install the Remote Development Extensions","text":"<p>Option A: Install Remote Development Pack (Recommended)</p> <ol> <li>Open VSCode</li> <li>Press Ctrl+Shift+X (or Cmd+Shift+X on Mac)</li> <li>Search for \"Remote Development\"</li> <li>Install the Remote Development extension pack by Microsoft</li> </ol> <p>This pack includes:</p> <ul> <li>Remote - SSH</li> <li>Remote - SSH: Editing Configuration Files</li> <li>Remote - Containers</li> <li>Remote - WSL (Windows only)</li> </ul> <p>Option B: Install Individual Extension</p> <ol> <li>Search for \"Remote - SSH\"</li> <li>Install Remote - SSH by Microsoft</li> </ol>"},{"location":"adv/vscode-ssh/#2-verify-installation","title":"2. Verify Installation","text":"<p>After installation, the following should be visible:</p> <ul> <li>Remote Explorer icon in the Activity Bar (left sidebar)</li> <li>\"Remote-SSH\" commands in Command Palette (Ctrl+Shift+P)</li> </ul>"},{"location":"adv/vscode-ssh/#part-2-configure-ssh-connections","title":"Part 2: Configure SSH Connections","text":""},{"location":"adv/vscode-ssh/#1-access-ssh-configuration","title":"1. Access SSH Configuration","text":"<p>Method A: Through VSCode</p> <ol> <li>Press Ctrl+Shift+P to open Command Palette</li> <li>Type \"Remote-SSH: Open SSH Configuration File...\"</li> <li>Select the SSH config file (usually the first option)</li> </ol> <p>Method B: Direct File Editing <pre><code># Edit SSH config file directly\nnano ~/.ssh/config\n</code></pre></p>"},{"location":"adv/vscode-ssh/#2-add-server-configurations","title":"2. Add Server Configurations","text":"<p>Add servers to the SSH config file:</p> <pre><code># Example Node\nHost node1\n HostName <tailscale-ip>\n User <username>\n IdentityFile ~/.ssh/id_rsa\n ForwardAgent yes\n ServerAliveInterval 60\n ServerAliveCountMax 3\n\n# Additional nodes (add as needed)\nHost node2\n HostName <tailscale-ip>\n User <username>\n IdentityFile ~/.ssh/id_rsa\n ForwardAgent yes\n ServerAliveInterval 60\n ServerAliveCountMax 3\n</code></pre> <p>Configuration Options Explained:</p> <ul> <li><code>Host</code>: Friendly name for the connection</li> <li><code>HostName</code>: Tailscale IP address</li> <li><code>User</code>: Username on the remote server</li> <li><code>IdentityFile</code>: Path to the SSH private key</li> <li><code>ForwardAgent</code>: Enables SSH agent forwarding for Git operations</li> <li><code>ServerAliveInterval</code>: Keeps connection alive (prevents timeouts)</li> <li><code>ServerAliveCountMax</code>: Number of keepalive attempts</li> </ul>"},{"location":"adv/vscode-ssh/#3-set-proper-ssh-key-permissions","title":"3. Set Proper SSH Key Permissions","text":"<pre><code># Ensure SSH config has correct permissions\nchmod 600 ~/.ssh/config\n\n# Verify SSH key permissions\nchmod 600 ~/.ssh/id_rsa\nchmod 644 ~/.ssh/id_rsa.pub\n</code></pre>"},{"location":"adv/vscode-ssh/#part-3-connect-to-remote-servers","title":"Part 3: Connect to Remote Servers","text":""},{"location":"adv/vscode-ssh/#1-connect-via-command-palette","title":"1. Connect via Command Palette","text":"<ol> <li>Press Ctrl+Shift+P</li> <li>Type \"Remote-SSH: Connect to Host...\"</li> <li>Select the server (e.g., <code>node1</code>)</li> <li>VSCode will open a new window connected to the remote server</li> </ol>"},{"location":"adv/vscode-ssh/#2-connect-via-remote-explorer","title":"2. Connect via Remote Explorer","text":"<ol> <li>Click the Remote Explorer icon in Activity Bar</li> <li>Expand SSH Targets</li> <li>Click the connect icon next to the server name</li> </ol>"},{"location":"adv/vscode-ssh/#3-connect-via-quick-menu","title":"3. Connect via Quick Menu","text":"<ol> <li>Click the remote indicator in bottom-left corner (looks like ><)</li> <li>Select \"Connect to Host...\"</li> <li>Choose the server from the list</li> </ol>"},{"location":"adv/vscode-ssh/#4-first-connection-process","title":"4. First Connection Process","text":"<p>On first connection, VSCode will:</p> <ol> <li>Verify the host key (click \"Continue\" if prompted)</li> <li>Install VSCode Server on the remote machine (automatic)</li> <li>Open a remote window with access to the remote file system</li> </ol> <p>Expected Timeline: - First connection: 1-3 minutes (installs VSCode Server) - Subsequent connections: 10-30 seconds</p>"},{"location":"adv/vscode-ssh/#part-4-remote-development-environment-setup","title":"Part 4: Remote Development Environment Setup","text":""},{"location":"adv/vscode-ssh/#1-open-remote-workspace","title":"1. Open Remote Workspace","text":"<p>Once connected:</p> <pre><code># In the VSCode terminal (now running on remote server)\n# Navigate to the project directory\ncd /home/<username>/projects\n\n# Open current directory in VSCode\ncode .\n\n# Or open a specific project\ncode /opt/myproject\n</code></pre>"},{"location":"adv/vscode-ssh/#2-install-extensions-on-remote-server","title":"2. Install Extensions on Remote Server","text":"<p>Extensions must be installed separately on the remote server:</p> <p>Essential Development Extensions:</p> <ol> <li>Python (Microsoft) - Python development</li> <li>GitLens (GitKraken) - Enhanced Git capabilities</li> <li>Docker (Microsoft) - Container development</li> <li>Prettier - Code formatting</li> <li>ESLint - JavaScript linting</li> <li>Auto Rename Tag - HTML/XML tag editing</li> </ol> <p>To Install:</p> <ol> <li>Go to Extensions (Ctrl+Shift+X)</li> <li>Find the desired extension</li> <li>Click \"Install in SSH: node1\" (not local install)</li> </ol>"},{"location":"adv/vscode-ssh/#3-configure-git-on-remote-server","title":"3. Configure Git on Remote Server","text":"<pre><code># In VSCode terminal (remote)\ngit config --global user.name \"<Full Name>\"\ngit config --global user.email \"<email@example.com>\"\n\n# Test Git connectivity\ngit clone https://github.com/<username>/<repo>.git\n</code></pre>"},{"location":"adv/vscode-ssh/#part-5-remote-development-workflows","title":"Part 5: Remote Development Workflows","text":""},{"location":"adv/vscode-ssh/#1-file-management","title":"1. File Management","text":"<p>File Explorer:</p> <ul> <li>Shows remote server's file system</li> <li>Create, edit, delete files directly</li> <li>Drag and drop between local and remote (limited)</li> </ul> <p>File Transfer: <pre><code># Upload files to remote (from local terminal)\nscp localfile.txt <username>@<tailscale-ip>:/home/<username>/\n\n# Download files from remote\nscp <username>@<tailscale-ip>:/remote/path/file.txt ./local/path/\n</code></pre></p>"},{"location":"adv/vscode-ssh/#2-terminal-usage","title":"2. Terminal Usage","text":"<p>Integrated Terminal:</p> <ul> <li>Press Ctrl+` to open terminal</li> <li>Runs directly on remote server</li> <li>Multiple terminals supported</li> <li>Full shell access (bash, zsh, etc.)</li> </ul> <p>Common Remote Terminal Commands: <pre><code># Check system resources\nhtop\ndf -h\nfree -h\n\n# Install packages\nsudo apt update\nsudo apt install nodejs npm\n\n# Start services\nsudo systemctl start nginx\nsudo docker-compose up -d\n</code></pre></p>"},{"location":"adv/vscode-ssh/#3-port-forwarding","title":"3. Port Forwarding","text":"<p>Automatic Port Forwarding: VSCode automatically detects and forwards common development ports.</p> <p>Manual Port Forwarding:</p> <ol> <li>Open Ports tab in terminal panel</li> <li>Click \"Forward a Port\"</li> <li>Enter port number (e.g., 3000, 8080, 5000)</li> <li>Access via <code>http://localhost:port</code> on the local machine</li> </ol> <p>Example: Web Development <pre><code># Start a web server on remote (port 3000)\nnpm start\n\n# VSCode automatically suggests forwarding port 3000\n# Access at http://localhost:3000 on the local machine\n</code></pre></p>"},{"location":"adv/vscode-ssh/#4-debugging-remote-applications","title":"4. Debugging Remote Applications","text":"<p>Python Debugging: <pre><code>// .vscode/launch.json on remote server\n{\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"name\": \"Python: Current File\",\n \"type\": \"python\",\n \"request\": \"launch\",\n \"program\": \"${file}\",\n \"console\": \"integratedTerminal\"\n }\n ]\n}\n</code></pre></p> <p>Node.js Debugging: <pre><code>// .vscode/launch.json\n{\n \"version\": \"0.2.0\",\n \"configurations\": [\n {\n \"name\": \"Launch Program\",\n \"type\": \"node\",\n \"request\": \"launch\",\n \"program\": \"${workspaceFolder}/app.js\"\n }\n ]\n}\n</code></pre></p>"},{"location":"adv/vscode-ssh/#part-6-advanced-configuration","title":"Part 6: Advanced Configuration","text":""},{"location":"adv/vscode-ssh/#1-workspace-settings","title":"1. Workspace Settings","text":"<p>Create remote-specific settings:</p> <pre><code>// .vscode/settings.json (on remote server)\n{\n \"python.defaultInterpreterPath\": \"/usr/bin/python3\",\n \"terminal.integrated.shell.linux\": \"/bin/bash\",\n \"files.autoSave\": \"afterDelay\",\n \"editor.formatOnSave\": true,\n \"remote.SSH.remotePlatform\": {\n \"node1\": \"linux\"\n }\n}\n</code></pre>"},{"location":"adv/vscode-ssh/#2-multi-server-management","title":"2. Multi-Server Management","text":"<p>Switch Between Servers:</p> <ol> <li>Click remote indicator (bottom-left)</li> <li>Select \"Connect to Host...\"</li> <li>Choose a different server</li> </ol> <p>Compare Files Across Servers:</p> <ol> <li>Open file from server A</li> <li>Connect to server B in new window</li> <li>Open corresponding file</li> <li>Use \"Compare with...\" command</li> </ol>"},{"location":"adv/vscode-ssh/#3-sync-configuration","title":"3. Sync Configuration","text":"<p>Settings Sync:</p> <ol> <li>Enable Settings Sync in VSCode</li> <li>Settings, extensions, and keybindings sync to remote</li> <li>Consistent experience across all servers</li> </ol>"},{"location":"adv/vscode-ssh/#part-7-project-specific-setups","title":"Part 7: Project-Specific Setups","text":""},{"location":"adv/vscode-ssh/#1-python-development","title":"1. Python Development","text":"<pre><code># On remote server\n# Create virtual environment\npython3 -m venv venv\nsource venv/bin/activate\n\n# Install packages\npip install flask django requests\n\n# VSCode automatically detects Python interpreter\n</code></pre> <p>VSCode Python Configuration: <pre><code>// .vscode/settings.json\n{\n \"python.defaultInterpreterPath\": \"./venv/bin/python\",\n \"python.linting.enabled\": true,\n \"python.linting.pylintEnabled\": true\n}\n</code></pre></p>"},{"location":"adv/vscode-ssh/#2-nodejs-development","title":"2. Node.js Development","text":"<pre><code># On remote server\n# Install Node.js\ncurl -fsSL https://deb.nodesource.com/setup_18.x | sudo -E bash -\nsudo apt-get install -y nodejs\n\n# Create project\nmkdir myapp && cd myapp\nnpm init -y\nnpm install express\n</code></pre>"},{"location":"adv/vscode-ssh/#3-docker-development","title":"3. Docker Development","text":"<pre><code># On remote server\n# Install Docker (if not already done via Ansible)\nsudo apt install docker.io docker-compose\nsudo usermod -aG docker $USER\n\n# Create Dockerfile\ncat > Dockerfile << EOF\nFROM node:18\nWORKDIR /app\nCOPY package*.json ./\nRUN npm install\nCOPY . .\nEXPOSE 3000\nCMD [\"npm\", \"start\"]\nEOF\n</code></pre> <p>VSCode Docker Integration:</p> <ul> <li>Install Docker extension on remote</li> <li>Right-click Dockerfile \u2192 \"Build Image\"</li> <li>Manage containers from VSCode interface</li> </ul>"},{"location":"adv/vscode-ssh/#part-8-troubleshooting-guide","title":"Part 8: Troubleshooting Guide","text":""},{"location":"adv/vscode-ssh/#common-connection-issues","title":"Common Connection Issues","text":"<p>Problem: \"Could not establish connection to remote host\"</p> <p>Solutions: <pre><code># Check Tailscale connectivity\ntailscale status\nping <tailscale-ip>\n\n# Test SSH manually\nssh <username>@<tailscale-ip>\n\n# Check SSH config syntax\nssh -T node1\n</code></pre></p> <p>Problem: \"Permission denied (publickey)\"</p> <p>Solutions: <pre><code># Check SSH key permissions\nchmod 600 ~/.ssh/id_rsa\nchmod 600 ~/.ssh/config\n\n# Verify SSH agent\nssh-add ~/.ssh/id_rsa\nssh-add -l\n\n# Test SSH connection verbosely\nssh -v <username>@<tailscale-ip>\n</code></pre></p> <p>Problem: \"Host key verification failed\"</p> <p>Solutions: <pre><code># Remove old host key\nssh-keygen -R <tailscale-ip>\n\n# Or disable host key checking (less secure)\n# Add to SSH config:\n# StrictHostKeyChecking no\n</code></pre></p>"},{"location":"adv/vscode-ssh/#vscode-specific-issues","title":"VSCode-Specific Issues","text":"<p>Problem: Extensions not working on remote</p> <p>Solutions:</p> <ol> <li>Install extensions specifically for the remote server</li> <li>Check extension compatibility with remote development</li> <li>Reload VSCode window: Ctrl+Shift+P \u2192 \"Developer: Reload Window\"</li> </ol> <p>Problem: Slow performance</p> <p>Solutions: - Use <code>.vscode/settings.json</code> to exclude large directories: <pre><code>{\n \"files.watcherExclude\": {\n \"**/node_modules/**\": true,\n \"**/.git/objects/**\": true,\n \"**/dist/**\": true\n }\n}\n</code></pre></p> <p>Problem: Terminal not starting</p> <p>Solutions: <pre><code># Check shell path in remote settings\n\"terminal.integrated.shell.linux\": \"/bin/bash\"\n\n# Or let VSCode auto-detect\n\"terminal.integrated.defaultProfile.linux\": \"bash\"\n</code></pre></p>"},{"location":"adv/vscode-ssh/#network-and-performance-issues","title":"Network and Performance Issues","text":"<p>Problem: Connection timeouts</p> <p>Solutions: Add to SSH config: <pre><code>ServerAliveInterval 60\nServerAliveCountMax 3\nTCPKeepAlive yes\n</code></pre></p> <p>Problem: File transfer slow</p> <p>Solutions: - Use <code>.vscodeignore</code> to exclude unnecessary files - Compress large files before transfer - Use <code>rsync</code> for large file operations: <pre><code>rsync -avz --progress localdir/ <username>@<tailscale-ip>:remotedir/\n</code></pre></p>"},{"location":"adv/vscode-ssh/#part-9-best-practices","title":"Part 9: Best Practices","text":""},{"location":"adv/vscode-ssh/#security-best-practices","title":"Security Best Practices","text":"<ol> <li>Use SSH keys, never passwords</li> <li>Keep SSH agent secure</li> <li>Regular security updates on remote servers</li> <li>Use VSCode's secure connection verification</li> </ol>"},{"location":"adv/vscode-ssh/#performance-optimization","title":"Performance Optimization","text":"<ol> <li> <p>Exclude unnecessary files: <pre><code>// .vscode/settings.json\n{\n \"files.watcherExclude\": {\n \"**/node_modules/**\": true,\n \"**/.git/**\": true,\n \"**/dist/**\": true,\n \"**/build/**\": true\n },\n \"search.exclude\": {\n \"**/node_modules\": true,\n \"**/bower_components\": true,\n \"**/*.code-search\": true\n }\n}\n</code></pre></p> </li> <li> <p>Use remote workspace for large projects</p> </li> <li>Close unnecessary windows and extensions</li> <li>Use efficient development workflows</li> </ol>"},{"location":"adv/vscode-ssh/#development-workflow","title":"Development Workflow","text":"<ol> <li> <p>Use version control effectively: <pre><code># Always work in Git repositories\ngit status\ngit add .\ngit commit -m \"feature: add new functionality\"\ngit push origin main\n</code></pre></p> </li> <li> <p>Environment separation: <pre><code># Development\nssh node1\ncd /home/<username>/dev-projects\n\n# Production\nssh node2\ncd /opt/production-apps\n</code></pre></p> </li> <li> <p>Backup important work: <pre><code># Regular backups via Git\ngit push origin main\n\n# Or manual backup\nscp -r <username>@<tailscale-ip>:/important/project ./backup/\n</code></pre></p> </li> </ol>"},{"location":"adv/vscode-ssh/#part-10-team-collaboration","title":"Part 10: Team Collaboration","text":""},{"location":"adv/vscode-ssh/#shared-development-servers","title":"Shared Development Servers","text":"<p>SSH Config for Team: <pre><code># Shared development server\nHost team-dev\n HostName <tailscale-ip>\n User <team-user>\n IdentityFile ~/.ssh/team_dev_key\n ForwardAgent yes\n\n# Personal development\nHost my-dev\n HostName <tailscale-ip>\n User <username>\n IdentityFile ~/.ssh/id_rsa\n</code></pre></p>"},{"location":"adv/vscode-ssh/#project-structure","title":"Project Structure","text":"<pre><code>/opt/projects/\n\u251c\u2500\u2500 project-a/\n\u2502 \u251c\u2500\u2500 dev/ # Development branch\n\u2502 \u251c\u2500\u2500 staging/ # Staging environment\n\u2502 \u2514\u2500\u2500 docs/ # Documentation\n\u251c\u2500\u2500 project-b/\n\u2514\u2500\u2500 shared-tools/ # Common utilities\n</code></pre>"},{"location":"adv/vscode-ssh/#access-management","title":"Access Management","text":"<pre><code># Create shared project directory\nsudo mkdir -p /opt/projects\nsudo chown -R :developers /opt/projects\nsudo chmod -R g+w /opt/projects\n\n# Add users to developers group\nsudo usermod -a -G developers <username>\n</code></pre>"},{"location":"adv/vscode-ssh/#quick-reference","title":"Quick Reference","text":""},{"location":"adv/vscode-ssh/#essential-vscode-remote-commands","title":"Essential VSCode Remote Commands","text":"<pre><code># Command Palette shortcuts\nCtrl+Shift+P \u2192 \"Remote-SSH: Connect to Host...\"\nCtrl+Shift+P \u2192 \"Remote-SSH: Open SSH Configuration File...\"\nCtrl+Shift+P \u2192 \"Remote-SSH: Kill VS Code Server on Host...\"\n\n# Terminal\nCtrl+` \u2192 Open integrated terminal\nCtrl+Shift+` \u2192 Create new terminal\n\n# File operations\nCtrl+O \u2192 Open file\nCtrl+S \u2192 Save file\nCtrl+Shift+E \u2192 Focus file explorer\n</code></pre>"},{"location":"adv/vscode-ssh/#ssh-connection-quick-test","title":"SSH Connection Quick Test","text":"<pre><code># Test connectivity\nssh -T node1\n\n# Connect with verbose output\nssh -v <username>@<tailscale-ip>\n\n# Check SSH config\nssh -F ~/.ssh/config node1\n</code></pre>"},{"location":"adv/vscode-ssh/#port-forwarding-commands","title":"Port Forwarding Commands","text":"<pre><code># Manual port forwarding\nssh -L 3000:localhost:3000 <username>@<tailscale-ip>\n\n# Background tunnel\nssh -f -N -L 8080:localhost:80 <username>@<tailscale-ip>\n</code></pre>"},{"location":"adv/vscode-ssh/#conclusion","title":"Conclusion","text":"<p>This remote development setup provides:</p> <ul> <li>Full development environment on remote servers</li> <li>Seamless file access and editing capabilities</li> <li>Integrated debugging and terminal access</li> <li>Port forwarding for web development</li> <li>Extension ecosystem available remotely</li> <li>Secure connections through Tailscale network</li> </ul> <p>The combination of VSCode Remote Development with Tailscale networking creates a powerful, flexible development environment that works from anywhere while maintaining security and performance.</p> <p>Whether developing Python applications, Node.js services, or managing Docker containers, this setup provides a professional remote development experience that rivals local development while leveraging the power and resources of remote servers.</p>"},{"location":"blog/2025/07/03/blog-1/","title":"Blog 1","text":"<p>Hello! Just putting something up here because, well, gosh darn, feels like the right thing to do. </p> <p>Making swift progress. Can now write things fast as heck lad. </p>"},{"location":"blog/2025/07/10/2/","title":"2","text":"<p>Wow. Big build day. Added (admittedly still buggy) shifts support to the system. Power did it in a day. </p> <p>Other updates recently include: </p> <ul> <li>Fully reworked backend <code>server.js</code> into modular components. </li> <li>Bunch of mobile related fixes and improvements.</li> <li>Bi-directional saving of configs fixed up </li> <li>Some style upgrades </li> </ul> <p>Need to make more content about how to use the system in general too. </p>"},{"location":"build/","title":"Getting Started","text":"<p>Welcome to Changemaker-Lite! You're about to reclaim your digital sovereignty and stop feeding your secrets to corporations. This guide will help you set up your own political infrastructure that you actually own and control.</p> <p>This documentation is broken into a few sections: </p> <ul> <li>Build: Instructions on how to build the cm-lite on your own hardware </li> <li>Services: Overview of all the services that are installed when you install cm-lite</li> <li>Configuration: Information on how to configure all the services that you install in cm-lite</li> <li>Manuals: Manuals on how to use the applications inside cm-lite (with videos!)</li> </ul>"},{"location":"build/#quick-start","title":"Quick Start","text":""},{"location":"build/#build-changemaker-lite","title":"Build Changemaker-Lite","text":"<pre><code># Clone the repository\ngit clone https://gitea.bnkops.com/admin/changemaker.lite\ncd changemaker.lite\n</code></pre> <p>Cloudflare Credentials</p> <p>The config.sh script will ask you for your Cloudflare credentials to get started. You can find more information on how to find this in the Cloudlflare Configuration</p> <pre><code># Configure environment (creates .env file)\n./config.sh\n</code></pre> <pre><code># Start all services\ndocker compose up -d\n</code></pre>"},{"location":"build/#optional-site-builld","title":"Optional - Site Builld","text":"<p>If you want to have your site prepared for launch, you can now proceed with reseting the site build. See Build Site for more detials. </p>"},{"location":"build/#deploy","title":"Deploy","text":"<p>Cloudflare</p> <p>Right now, we suggest deploying using Cloudflare for simplicity and protections against 99% of surface level attacks to digital infrastructure. If you want to avoid using this service, we recommend checking out Pagolin as a drop in replacement. </p> <p>For secure public access, use the production deployment script:</p> <pre><code>./start-production.sh\n</code></pre>"},{"location":"build/#why-changemaker-lite","title":"Why Changemaker Lite?","text":"<p>Before we dive into the technical setup, let's be clear about what you're doing here:</p> <p>The Reality</p> <p>If you do politics, who is reading your secrets? Every corporate platform you use is extracting your power, selling your data, and building profiles on your community. It's time to break free.</p>"},{"location":"build/#what-youre-getting","title":"What You're Getting","text":"<ul> <li>Data Sovereignty: Your data stays on your servers</li> <li>Cost Savings: $50/month instead of $2,000+/month for corporate solutions </li> <li>Community Control: Technology that serves movements, not shareholders</li> <li>Trans Liberation: Tools built with radical politics and care</li> </ul>"},{"location":"build/#what-youre-leaving-behind","title":"What You're Leaving Behind","text":"<ul> <li>\u274c Corporate surveillance and data extraction</li> <li>\u274c Escalating subscription fees and vendor lock-in</li> <li>\u274c Algorithmic manipulation of your community</li> <li>\u274c Terms of service that can silence you anytime</li> </ul>"},{"location":"build/#system-requirements","title":"System Requirements","text":""},{"location":"build/#operating-system","title":"Operating System","text":"<ul> <li>Ubuntu 24.04 LTS (Noble Numbat) - Recommended and tested</li> </ul> <p>Getting Started on Ubunut</p> <p>Want some help getting started with a baseline buildout for a Ubunut server? You can use our BNKops Server Build Script</p> <ul> <li>Other Linux distributions with systemd support</li> <li>WSL2 on Windows (limited functionality)</li> <li>Mac OS</li> </ul> <p>New to Linux?</p> <p>Consider Linux Mint - it looks like Windows but opens the door to true digital freedom.</p>"},{"location":"build/#hardware-requirements","title":"Hardware Requirements","text":"<ul> <li>CPU: 2+ cores (4+ recommended)</li> <li>RAM: 4GB minimum (8GB recommended) </li> <li>Storage: 20GB+ available disk space</li> <li>Network: Stable internet connection</li> </ul> <p>Cloud Hosting</p> <p>You can run this on a VPS from providers like Hetzner, DigitalOcean, or Linode for ~$20/month.</p>"},{"location":"build/#software-prerequisites","title":"Software Prerequisites","text":"<p>Getting Started on Docker</p> <p>Want some help getting started with a baseline buildout for a Ubunutu server? You can use our BNKops Server Build Script to roll out a configured server in about 20 mins! </p> <ol> <li>Docker Engine (24.0+)</li> </ol> <pre><code># Install Docker\ncurl -fsSL https://get.docker.com | sudo sh\n\n# Add your user to docker group\nsudo usermod -aG docker $USER\n\n# Log out and back in for group changes to take effect\n</code></pre> <ol> <li>Docker Compose (v2.20+)</li> </ol> <pre><code># Verify Docker Compose v2 is installed\ndocker compose version\n</code></pre> <ol> <li>Essential Tools</li> </ol> <pre><code># Install required packages\nsudo apt update\nsudo apt install -y git curl jq openssl\n</code></pre>"},{"location":"build/#installation","title":"Installation","text":""},{"location":"build/#1-clone-repository","title":"1. Clone Repository","text":"<pre><code>git clone https://gitea.bnkops.com/admin/changemaker.lite\ncd changemaker.lite\n</code></pre>"},{"location":"build/#2-run-configuration-wizard","title":"2. Run Configuration Wizard","text":"<p>The <code>config.sh</code> script will guide you through the initial setup:</p> <pre><code>./config.sh\n</code></pre> <p>This wizard will:</p> <ul> <li>\u2705 Create a <code>.env</code> file with secure defaults</li> <li>\u2705 Scan for available ports to avoid conflicts</li> <li>\u2705 Set up your domain configuration</li> <li>\u2705 Generate secure passwords for databases</li> <li>\u2705 Configure Cloudflare credentials (optional)</li> <li>\u2705 Update all configuration files with your settings</li> </ul>"},{"location":"build/#configuration-options","title":"Configuration Options","text":"<p>During setup, you'll be prompted for:</p> <ol> <li>Domain Name: Your primary domain (e.g., <code>example.com</code>)</li> <li>Cloudflare Settings (optional):</li> <li>API Token</li> <li>Zone ID</li> <li>Account ID</li> <li>Admin Credentials:</li> <li>Listmonk admin email and password</li> <li>n8n admin email and password</li> </ol>"},{"location":"build/#3-start-services","title":"3. Start Services","text":"<p>Launch all services with Docker Compose:</p> <pre><code>docker compose up -d\n</code></pre> <p>Wait for services to initialize (first run may take 5-10 minutes):</p> <pre><code># Watch container status\ndocker compose ps\n\n# View logs\ndocker compose logs -f\n</code></pre>"},{"location":"build/#4-verify-installation","title":"4. Verify Installation","text":"<p>Check that all services are running:</p> <pre><code>docker compose ps\n</code></pre> <p>Expected output should show all services as \"Up\":</p> <ul> <li>code-server-changemaker</li> <li>listmonk_app</li> <li>listmonk_db</li> <li>mkdocs-changemaker</li> <li>mkdocs-site-server-changemaker</li> <li>n8n-changemaker</li> <li>nocodb</li> <li>root_db</li> <li>homepage-changemaker</li> <li>gitea_changemaker</li> <li>gitea_mysql_changemaker</li> <li>mini-qr</li> </ul>"},{"location":"build/#local-access","title":"Local Access","text":"<p>Once services are running, access them locally:</p>"},{"location":"build/#homepage-dashboard","title":"\ud83c\udfe0 Homepage Dashboard","text":"<ul> <li>URL: http://localhost:3010 </li> <li>Purpose: Central hub for all services </li> <li>Features: Service status, quick links, monitoring</li> </ul>"},{"location":"build/#development-tools","title":"\ud83d\udcbb Development Tools","text":"<ul> <li>Code Server: http://localhost:8888 \u2014 VS Code in browser </li> <li>Gitea: http://localhost:3030 \u2014 Git repository management </li> <li>MkDocs Dev: http://localhost:4000 \u2014 Live documentation preview </li> <li>MkDocs Prod: http://localhost:4001 \u2014 Built documentation</li> </ul>"},{"location":"build/#communication","title":"\ud83d\udce7 Communication","text":"<ul> <li>Listmonk: http://localhost:9000 \u2014 Email campaigns Login with credentials set during configuration</li> </ul>"},{"location":"build/#automation-data","title":"\ud83d\udd04 Automation & Data","text":"<ul> <li>n8n: http://localhost:5678 \u2014 Workflow automation Login with credentials set during configuration </li> <li>NocoDB: http://localhost:8090 \u2014 No-code database</li> </ul>"},{"location":"build/#interactive-tools","title":"\ud83d\udee0\ufe0f Interactive Tools","text":"<ul> <li>Mini QR: http://localhost:8089 \u2014 QR code generator</li> </ul>"},{"location":"build/#map","title":"Map","text":"<p>Map</p> <p>Map is the canvassing application that is custom view of nocodb data. Map is best built after production deployment to reduce duplicate build efforts. </p>"},{"location":"build/#map-manual","title":"Map Manual","text":""},{"location":"build/#production-deployment","title":"Production Deployment","text":""},{"location":"build/#deploy-with-cloudflare-tunnels","title":"Deploy with Cloudflare Tunnels","text":"<p>For secure public access, use the production deployment script:</p> <pre><code>./start-production.sh\n</code></pre> <p>This script will:</p> <ol> <li>Install and configure <code>cloudflared</code></li> <li>Create a Cloudflare tunnel</li> <li>Set up DNS records automatically</li> <li>Configure access policies</li> <li>Create a systemd service for persistence</li> </ol>"},{"location":"build/#what-happens-during-production-setup","title":"What Happens During Production Setup","text":"<ol> <li>Cloudflare Authentication: Browser-based login to Cloudflare</li> <li>Tunnel Creation: Secure tunnel named <code>changemaker-lite</code></li> <li>DNS Configuration: Automatic CNAME records for all services</li> <li>Access Policies: Email-based authentication for sensitive services</li> <li>Service Installation: Systemd service for automatic startup</li> </ol>"},{"location":"build/#production-urls","title":"Production URLs","text":"<p>After successful deployment, services will be available at:</p> <p>Public Services:</p> <ul> <li><code>https://yourdomain.com</code> - Main documentation site</li> <li><code>https://listmonk.yourdomain.com</code> - Email campaigns</li> <li><code>https://docs.yourdomain.com</code> - Documentation preview</li> <li><code>https://n8n.yourdomain.com</code> - Automation platform</li> <li><code>https://db.yourdomain.com</code> - NocoDB</li> <li><code>https://git.yourdomain.com</code> - Gitea</li> <li><code>https://map.yourdomain.com</code> - Map viewer</li> <li><code>https://qr.yourdomain.com</code> - QR generator</li> </ul> <p>Protected Services (require authentication):</p> <ul> <li><code>https://homepage.yourdomain.com</code> - Dashboard</li> <li><code>https://code.yourdomain.com</code> - Code Server</li> </ul>"},{"location":"build/#configuration-management","title":"Configuration Management","text":""},{"location":"build/#environment-variables","title":"Environment Variables","text":"<p>Key settings in <code>.env</code> file:</p> <pre><code># Domain Configuration\nDOMAIN=yourdomain.com\nBASE_DOMAIN=https://yourdomain.com\n\n# Service Ports (automatically assigned to avoid conflicts)\nHOMEPAGE_PORT=3010\nCODE_SERVER_PORT=8888\nLISTMONK_PORT=9000\nMKDOCS_PORT=4000\nMKDOCS_SITE_SERVER_PORT=4001\nN8N_PORT=5678\nNOCODB_PORT=8090\nGITEA_WEB_PORT=3030\nGITEA_SSH_PORT=2222\nMAP_PORT=3000\nMINI_QR_PORT=8089\n\n# Cloudflare (for production)\nCF_API_TOKEN=your_token\nCF_ZONE_ID=your_zone_id\nCF_ACCOUNT_ID=your_account_id\n</code></pre>"},{"location":"build/#reconfigure-services","title":"Reconfigure Services","text":"<p>To update configuration:</p> <pre><code># Re-run configuration wizard\n./config.sh\n\n# Restart services\ndocker compose down && docker compose up -d\n</code></pre>"},{"location":"build/#common-tasks","title":"Common Tasks","text":""},{"location":"build/#service-management","title":"Service Management","text":"<pre><code># View all services\ndocker compose ps\n\n# View logs for specific service\ndocker compose logs -f [service-name]\n\n# Restart a service\ndocker compose restart [service-name]\n\n# Stop all services\ndocker compose down\n\n# Stop and remove all data (CAUTION!)\ndocker compose down -v\n</code></pre>"},{"location":"build/#backup-data","title":"Backup Data","text":"<pre><code># Backup all volumes\ndocker run --rm -v changemaker_listmonk-data:/data -v $(pwd):/backup alpine tar czf /backup/listmonk-backup.tar.gz -C /data .\n\n# Backup configuration\ntar czf configs-backup.tar.gz configs/\n\n# Backup documentation\ntar czf docs-backup.tar.gz mkdocs/docs/\n</code></pre>"},{"location":"build/#update-services","title":"Update Services","text":"<pre><code># Pull latest images\ndocker compose pull\n\n# Recreate containers with new images\ndocker compose up -d\n</code></pre>"},{"location":"build/#troubleshooting","title":"Troubleshooting","text":""},{"location":"build/#port-conflicts","title":"Port Conflicts","text":"<p>If services fail to start due to port conflicts:</p> <ol> <li>Check which ports are in use:</li> </ol> <pre><code>sudo ss -tulpn | grep LISTEN\n</code></pre> <ol> <li>Re-run configuration to get new ports:</li> </ol> <pre><code>./config.sh\n</code></pre> <ol> <li>Or manually edit <code>.env</code> file and change conflicting ports</li> </ol>"},{"location":"build/#permission-issues","title":"Permission Issues","text":"<p>Fix permission problems:</p> <pre><code># Get your user and group IDs\nid -u # User ID\nid -g # Group ID\n\n# Update .env file with correct IDs\nUSER_ID=1000\nGROUP_ID=1000\n\n# Restart services\ndocker compose down && docker compose up -d\n</code></pre>"},{"location":"build/#service-wont-start","title":"Service Won't Start","text":"<p>Debug service issues:</p> <pre><code># Check detailed logs\ndocker compose logs [service-name] --tail 50\n\n# Check container status\ndocker ps -a\n\n# Inspect container\ndocker inspect [container-name]\n</code></pre>"},{"location":"build/#cloudflare-tunnel-issues","title":"Cloudflare Tunnel Issues","text":"<pre><code># Check tunnel service status\nsudo systemctl status cloudflared-changemaker\n\n# View tunnel logs\nsudo journalctl -u cloudflared-changemaker -f\n\n# Restart tunnel\nsudo systemctl restart cloudflared-changemaker\n</code></pre>"},{"location":"build/#next-steps","title":"Next Steps","text":"<p>Now that your Changemaker Lite instance is running:</p> <ol> <li>Set up Listmonk - Configure SMTP and create your first campaign</li> <li>Create workflows - Build automations in n8n</li> <li>Import data - Set up your NocoDB databases</li> <li>Configure map - Add location data for the map viewer</li> <li>Write documentation - Start creating content in MkDocs</li> <li>Set up Git - Initialize repositories in Gitea</li> </ol>"},{"location":"build/#getting-help","title":"Getting Help","text":"<ul> <li>Check the Services documentation for detailed guides</li> <li>Review container logs for specific error messages</li> <li>Ensure all prerequisites are properly installed</li> <li>Verify your domain DNS settings for production deployment</li> </ul>"},{"location":"build/map/","title":"Map Build Guide","text":"<p>Map is BNKops canvassing application built for community organizing and door-to-door canvassing.</p> <p>Complete Configuration</p> <p>For detailed configuration, usage instructions, and troubleshooting, see the Map Configuration Guide.</p> <p>Clean NocoDB</p> <p>Currently the way to get a good result is to ensure the target nocodb database is empty. You can do this by deleting all bases. The script should still work with other volumes however may insert tables into odd locations; still debugging. Again, see config if needing to do manually. </p>"},{"location":"build/map/#prerequisites","title":"Prerequisites","text":"<ul> <li>Docker and Docker Compose installed</li> <li>NocoDB instance with API access</li> <li>Domain name (optional but recommended for production)</li> </ul>"},{"location":"build/map/#quick-build-process","title":"Quick Build Process","text":""},{"location":"build/map/#1-get-nocodb-api-token","title":"1. Get NocoDB API Token","text":"<ol> <li>Login to your NocoDB instance</li> <li>Click user icon \u2192 Account Settings \u2192 API Tokens</li> <li>Create new token with read/write permissions</li> <li>Copy the token for the next step</li> </ol>"},{"location":"build/map/#2-configure-environment","title":"2. Configure Environment","text":"<p>Edit the <code>.env</code> file in the <code>map/</code> directory:</p> <pre><code>cd map\n</code></pre> <p>Update your <code>.env</code> file with your NocoDB details, specifically the instance and api token:</p> <pre><code># NocoDB API Configuration\nNOCODB_API_URL=https://your-nocodb-instance.com/api/v1\nNOCODB_API_TOKEN=your-api-token-here\n\n# These will be populated after running build-nocodb.sh\nNOCODB_VIEW_URL=\nNOCODB_LOGIN_SHEET=\nNOCODB_SETTINGS_SHEET=\n\n# Server Configuration\nPORT=3000\nNODE_ENV=production\nSESSION_SECRET=your-secure-random-string\n\n# Map Defaults (Edmonton, AB)\nDEFAULT_LAT=53.5461\nDEFAULT_LNG=-113.4938\nDEFAULT_ZOOM=11\n\n# Production Settings\nCOOKIE_DOMAIN=.yourdomain.com\nALLOWED_ORIGINS=https://map.yourdomain.com,http://localhost:3000\n</code></pre>"},{"location":"build/map/#3-auto-create-database-structure","title":"3. Auto-Create Database Structure","text":"<p>Run the build script to create required tables:</p> <pre><code>chmod +x build-nocodb.sh\n./build-nocodb.sh\n</code></pre> <p>This creates three tables: - Locations - Main map data with geo-location, contact info, support levels - Login - User authentication (email, name, admin flag) - Settings - Admin configuration and QR codes</p>"},{"location":"build/map/#4-get-table-urls","title":"4. Get Table URLs","text":"<p>After the script completes:</p> <ol> <li>Login to your NocoDB instance</li> <li>Navigate to your project (\"Map Viewer Project\")</li> <li>Copy the view URLs for each table from your browser address bar</li> <li>URLs should look like: <code>https://your-nocodb.com/dashboard/#/nc/project-id/table-id</code></li> </ol>"},{"location":"build/map/#5-update-environment-with-urls","title":"5. Update Environment with URLs","text":"<p>Edit your <code>.env</code> file and add the table URLs:</p> <pre><code>NOCODB_VIEW_URL=https://your-nocodb.com/dashboard/#/nc/project-id/locations-table-id\nNOCODB_LOGIN_SHEET=https://your-nocodb.com/dashboard/#/nc/project-id/login-table-id\nNOCODB_SETTINGS_SHEET=https://your-nocodb.com/dashboard/#/nc/project-id/settings-table-id\n</code></pre>"},{"location":"build/map/#6-build-and-deploy","title":"6. Build and Deploy","text":"<p>Build the Docker image and start the application:</p> <pre><code># Build the Docker image\ndocker-compose build\n\n# Start the application\ndocker-compose up -d\n</code></pre>"},{"location":"build/map/#verify-installation","title":"Verify Installation","text":"<ol> <li> <p>Check container status: <pre><code>docker-compose ps\n</code></pre></p> </li> <li> <p>View logs: <pre><code>docker-compose logs -f map-viewer\n</code></pre></p> </li> <li> <p>Access the application at <code>http://localhost:3000</code></p> </li> </ol>"},{"location":"build/map/#quick-start","title":"Quick Start","text":"<ol> <li>Login: Use an email from your Login table</li> <li>Add Locations: Click on the map to add new locations</li> <li>Admin Panel: Admin users can access <code>/admin.html</code> for configuration</li> <li>Walk Sheets: Generate printable canvassing forms with QR codes</li> </ol>"},{"location":"build/map/#maintenance-commands","title":"Maintenance Commands","text":""},{"location":"build/map/#update-application","title":"Update Application","text":"<pre><code>docker-compose down\ngit pull origin main\ndocker-compose build\ndocker-compose up -d\n</code></pre>"},{"location":"build/map/#development-mode","title":"Development Mode","text":"<pre><code>cd app\nnpm install\nnpm run dev\n</code></pre>"},{"location":"build/map/#health-check","title":"Health Check","text":"<pre><code>curl http://localhost:3000/health\n</code></pre>"},{"location":"build/map/#support","title":"Support","text":"<p>For detailed configuration, troubleshooting, and usage instructions, see the Map Configuration Guide.</p>"},{"location":"build/server/","title":"BNKops Server Build","text":"<p>Purpose: a Ubuntu server build-out for general application </p> <p>This documentation is a overview of the full build out for a server OS and baseline for running Changemaker-lite. It is a manual to re-install this server on any machine. </p> <p>All of the following systems are free and the majority are open source. </p>"},{"location":"build/server/#ubuntu-os","title":"Ubuntu OS","text":"<p>Ubuntu is a Linux distribution derived from Debian and composed mostly of free and open-source software.</p>"},{"location":"build/server/#install-ubuntu","title":"Install Ubuntu","text":""},{"location":"build/server/#post-install","title":"Post Install","text":"<p>Post installation, run update: <pre><code>sudo apt update\n</code></pre></p> <pre><code>sudo apt upgrade\n</code></pre>"},{"location":"build/server/#configuration","title":"Configuration","text":"<p>Further configurations: </p> <ul> <li>User profile was updated to Automatically Login </li> <li>Remote Desktop, Sharing, and Login have all been enabled. </li> <li>Default system settings have been set to dark mode. </li> </ul>"},{"location":"build/server/#vscode-insiders","title":"VSCode Insiders","text":"<p>Visual Studio Code is a new choice of tool that combines the simplicity of a code editor with what developers need for the core edit-build-debug cycle.</p>"},{"location":"build/server/#install-using-app-centre","title":"Install Using App Centre","text":""},{"location":"build/server/#obsidian","title":"Obsidian","text":"<p>The free and flexible app for your private\u00a0thoughts.</p>"},{"location":"build/server/#install-using-app-center","title":"Install Using App Center","text":""},{"location":"build/server/#curl","title":"Curl","text":"<p>command line tool and library for transferring data with URLs (since 1998)</p>"},{"location":"build/server/#install","title":"Install","text":"<pre><code>sudo apt install curl \n</code></pre>"},{"location":"build/server/#glances","title":"Glances","text":"<p>Glances an Eye on your system. A top/htop alternative for GNU/Linux, BSD, Mac OS and Windows operating systems.</p>"},{"location":"build/server/#install_1","title":"Install","text":"<pre><code>sudo snap install glances \n</code></pre>"},{"location":"build/server/#syncthing","title":"Syncthing","text":"<p>Syncthing is a continuous file synchronization program. It synchronizes files between two or more computers in real time, safely protected from prying eyes. Your data is your data alone and you deserve to choose where it is stored, whether it is shared with some third party, and how it\u2019s transmitted over the internet.</p>"},{"location":"build/server/#install_2","title":"Install","text":"<pre><code># Add the release PGP keys:\nsudo mkdir -p /etc/apt/keyrings\nsudo curl -L -o /etc/apt/keyrings/syncthing-archive-keyring.gpg https://syncthing.net/release-key.gpg\n</code></pre> <pre><code># Add the \"stable\" channel to your APT sources:\necho \"deb [signed-by=/etc/apt/keyrings/syncthing-archive-keyring.gpg] https://apt.syncthing.net/ syncthing stable\" | sudo tee /etc/apt/sources.list.d/syncthing.list\n</code></pre> <pre><code># Update and install syncthing:\nsudo apt-get update\nsudo apt-get install syncthing\n</code></pre>"},{"location":"build/server/#post-install_1","title":"Post Install","text":"<p>Run syncthing as a system service. <pre><code>sudo systemctl start syncthing@yourusername\n</code></pre></p> <pre><code>sudo systemctl enable syncthing@yourusername\n</code></pre>"},{"location":"build/server/#docker","title":"Docker","text":"<p>Docker helps developers build, share, run, and verify applications anywhere \u2014 without tedious environment configuration or management. <pre><code># Add Docker's official GPG key:\nsudo apt-get update\nsudo apt-get install ca-certificates curl\nsudo install -m 0755 -d /etc/apt/keyrings\nsudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc\nsudo chmod a+r /etc/apt/keyrings/docker.asc\n\n# Add the repository to Apt sources:\necho \\\n \"deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \\\n $(. /etc/os-release && echo \"${UBUNTU_CODENAME:-$VERSION_CODENAME}\") stable\" | \\\n sudo tee /etc/apt/sources.list.d/docker.list > /dev/null\nsudo apt-get update\n</code></pre></p> <pre><code>sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin\n</code></pre>"},{"location":"build/server/#update-users","title":"Update Users","text":"<pre><code>sudo groupadd docker\n</code></pre> <pre><code>sudo usermod -aG docker $USER\n</code></pre> <pre><code>newgrp docker\n</code></pre>"},{"location":"build/server/#enable-on-boot","title":"Enable on Boot","text":"<pre><code>sudo systemctl enable docker.service\nsudo systemctl enable containerd.service\n</code></pre>"},{"location":"build/server/#cloudflared","title":"Cloudflared","text":"<p>Connect, protect, and build everywhere. We make websites, apps, and networks faster and more secure. Our developer platform is the best place to build modern apps and deliver AI initiatives.</p> <pre><code>sudo mkdir -p --mode=0755 /usr/share/keyrings\ncurl -fsSL https://pkg.cloudflare.com/cloudflare-main.gpg | sudo tee /usr/share/keyrings/cloudflare-main.gpg >/dev/null\n</code></pre> <pre><code>echo \"deb [signed-by=/usr/share/keyrings/cloudflare-main.gpg] https://pkg.cloudflare.com/cloudflared any main\" | sudo tee /etc/apt/sources.list.d/cloudflared.list\n</code></pre> <pre><code>sudo apt-get update && sudo apt-get install cloudflared\n</code></pre>"},{"location":"build/server/#post-install_2","title":"Post Install","text":"<p>Login to Cloudflare <pre><code>cloudflared login\n</code></pre></p>"},{"location":"build/server/#configuration_1","title":"Configuration","text":"<p>The <code>./config.sh</code> and <code>./start-production.sh</code> scripts will properly configure a Cloudflare tunnel and service to put your system online. More info in the Cloudflare Configuration.</p>"},{"location":"build/server/#pandoc","title":"Pandoc","text":"<p>If you need to convert files from one markup format into another, pandoc is your swiss-army knife. </p> <pre><code>sudo apt install pandoc\n</code></pre>"},{"location":"build/site/","title":"Building the Site with MkDocs Material","text":"<p>Welcome! This guide will help you get started building and customizing your site using MkDocs Material.</p>"},{"location":"build/site/#reset-site","title":"Reset Site","text":"<p>You can read through all the BNKops cmlite documentation already in your docs folder or you can reset your docs folder to a baseline to start and read more manuals here. To reset docs folder to baseline, run the following: </p> <pre><code>./reset-site.sh\n</code></pre>"},{"location":"build/site/#how-to-build-your-site-step-by-step","title":"\ud83d\ude80 How to Build Your Site (Step by Step)","text":"<ol> <li>Open your Coder instance. For example: coder.yourdomain.com</li> <li>Go to the mkdocs folder: In the terminal (for a new terminal press Crtl - Shift - ~), type: <pre><code>cd mkdocs\n</code></pre></li> <li>Build the site: Type: <pre><code>mkdocs build\n</code></pre> This creates the static website from your documents and places them in the <code>mkdocs/site</code> directory.</li> </ol> <p>Preview your site locally: Visit localhost:4000 for local development or <code>live.youdomain.com</code> to see a public live load. </p> <ul> <li>All documentation in the <code>mkdocs/docs</code> folder is included automatically.</li> <li>The site uses the beautiful and easy-to-use Material for MkDocs theme.</li> </ul> <p>Material for MkDocs Documentation </p> <p>Build vs Serve</p> <p>Your website is built in stages. Any edits to documents in the mkdocs directory are instantly served and visible at localhost:4000 or if in production mode live.yourdomain.com. The live site is not meant as a public access point and will crash if too many requests are made to it. </p> <p>Running <code>mkdocs build</code> pushes any changes to the <code>site</code> directory, which then a ngnix server pushes them to the production server for public access at your root domain (yourdomain.com). </p> <p>You can think of it as serve/live = draft for personal review and build = save/push to production for the public. </p> <p>This combination allows for rapid development of documentation while ensuring your live site does not get updated until your content is ready. </p>"},{"location":"build/site/#resetting-the-site","title":"\ud83e\uddf9 Resetting the Site","text":"<p>If you want to start fresh:</p> <ol> <li> <p>Delete all folders EXCEPT these folders:</p> <ul> <li><code>/blog</code></li> <li><code>/javascripts</code></li> <li><code>/hooks</code></li> <li><code>/assets</code></li> <li><code>/stylesheets</code></li> <li><code>/overrides</code></li> </ul> </li> <li> <p>Reset the landing page:</p> <ul> <li>Open the main <code>index.md</code> file and remove everything at the very top (the \"front matter\").</li> <li>Or edit <code>/overrides/home.html</code> to change the landing page.</li> </ul> </li> <li> <p>Reset the <code>mkdocs.yml</code> </p> <ul> <li>Open <code>mkdocs.yml</code> and delete the <code>nav</code> section entirely. </li> <li>This action will enable mkdocs to build your site navigation based on file names in the root directory. </li> </ul> </li> </ol>"},{"location":"build/site/#using-ai-to-help-build-your-site","title":"\ud83e\udd16 Using AI to Help Build Your Site","text":"<ul> <li>If you have a claude.ai subscription, you can use powerful AI in your Coder terminal to write or rewrite pages, including a new <code>home.html</code>.</li> <li>All you need to do is open the terminal and type: <pre><code>claude\n</code></pre></li> <li>You can also try local AI tools like Ollama for on-demand help.</li> </ul>"},{"location":"build/site/#first-time-setup-tips","title":"\ud83d\udee0\ufe0f First-Time Setup Tips","text":"<ul> <li>Navigation: Open <code>mkdocs.yml</code> and remove the <code>nav</code> section to start with a blank menu. Add your own pages as you go.</li> <li>Customize the look: Check out the Material for MkDocs customization guide.</li> <li>Live preview: Use <code>mkdocs serve</code> (see above) to see changes instantly as you edit.</li> <li>Custom files: Put your own CSS, JavaScript, or HTML in <code>/assets</code>, <code>/stylesheets</code>, <code>/javascripts</code>, or <code>/overrides</code>.</li> </ul> <p>Quick Start Guide </p>"},{"location":"build/site/#more-resources","title":"\ud83d\udcda More Resources","text":"<ul> <li>MkDocs User Guide </li> <li>Material for MkDocs Features </li> <li>BNKops MKdocs Configuration & Customization</li> </ul> <p>Happy building!</p>"},{"location":"config/","title":"Configuration","text":"<p>There are several configuration steps to building a production ready Changemaker-Lite. </p> <p>In the order we suggest doing them: </p>"},{"location":"config/cloudflare-config/","title":"Configure Cloudflare","text":"<p>Cloudflare is the largest DNS routing service on the planet. We use their free service tier to provide Changemaker users with a fast, secure, and reliable way to get online that blocks 99% of surface level attacks and has built in user authenticaion (if you so choose to use it)</p>"},{"location":"config/cloudflare-config/#credentials","title":"Credentials","text":"<p>The <code>config.sh</code> and <code>start-production.sh</code> scripts require the following Cloudflare credentials to function properly:</p>"},{"location":"config/cloudflare-config/#1-cloudflare-api-token","title":"1. Cloudflare API Token","text":"<ul> <li>Purpose: Used to authenticate API requests to Cloudflare for managing DNS records, tunnels, and access policies.</li> <li>Required Permissions:<ul> <li><code>Zone.DNS</code> (Read/Write)</li> <li><code>Account.Cloudflare Tunnel</code> (Read/Write)</li> </ul> </li> <li>How to Obtain:<ul> <li>Log in to your Cloudflare account.</li> <li>Go to My Profile > API Tokens > Create Token.</li> <li>Use the Edit zone DNS template and add Cloudflare Tunnel permissions.</li> </ul> </li> </ul>"},{"location":"config/cloudflare-config/#2-cloudflare-zone-id","title":"2. Cloudflare Zone ID","text":"<ul> <li>Purpose: Identifies the specific DNS zone (domain) in Cloudflare where DNS records will be created.</li> <li>How to Obtain:<ul> <li>Log in to your Cloudflare account.</li> <li>Select the domain you want to use.</li> <li>The Zone ID is displayed in the Overview section under API.</li> </ul> </li> </ul>"},{"location":"config/cloudflare-config/#3-cloudflare-account-id","title":"3. Cloudflare Account ID","text":"<ul> <li>Purpose: Identifies your Cloudflare account for tunnel creation and management.</li> <li>How to Obtain:<ul> <li>Log in to your Cloudflare account.</li> <li>Go to My Profile > API Tokens.</li> <li>The Account ID is displayed at the top of the page.</li> </ul> </li> </ul>"},{"location":"config/cloudflare-config/#4-cloudflare-tunnel-id-optional-in-configsh-required-in-start-productionsh","title":"4. Cloudflare Tunnel ID (Optional in config.sh, Required in start-production.sh)","text":"<p>Automatic Configuration of Tunnel</p> <p>The <code>start-production.sh</code> script will automatically create a tunnel and system service for Cloudflare.</p> <ul> <li>Purpose: Identifies the specific Cloudflare Tunnel that will be used to route traffic to your services.</li> <li>How to Obtain:<ul> <li>This is automatically generated when you create a tunnel using <code>cloudflared tunnel create</code> or via the Cloudflare dashboard.</li> </ul> </li> <li>The start-production.sh script will create this for you if it doesn't exist.</li> </ul>"},{"location":"config/cloudflare-config/#summary-of-required-credentials","title":"Summary of Required Credentials:","text":"<pre><code># In .env file\nCF_API_TOKEN=your_cloudflare_api_token\nCF_ZONE_ID=your_cloudflare_zone_id\nCF_ACCOUNT_ID=your_cloudflare_account_id\nCF_TUNNEL_ID=will_be_set_by_start_production # This will be set by start-production.sh\n</code></pre>"},{"location":"config/cloudflare-config/#notes","title":"Notes:","text":"<ul> <li>The config.sh script will prompt you for these credentials during setup.</li> <li>The start-production.sh script will verify these credentials and use them to configure DNS records, create tunnels, and set up access policies.</li> <li>Ensure that the API token has the correct permissions, or the scripts will fail to configure Cloudflare services.</li> </ul>"},{"location":"config/coder/","title":"Coder Server Configuration","text":"<p>This section describes the configuration and features of the code-server environment.</p>"},{"location":"config/coder/#accessing-code-server","title":"Accessing Code Server","text":"<ul> <li>URL: <code>http://localhost:8080</code></li> <li>Authentication: Password-based (see below for password retrieval)</li> </ul>"},{"location":"config/coder/#retrieving-the-code-server-password","title":"Retrieving the Code Server Password","text":"<p>After the first build, the code-server password is stored in:</p> <pre><code>configs/code-server/.config/code-server/config.yaml\n</code></pre> <p>Look for the <code>password:</code> field in that file. For example:</p> <pre><code>password: 0c0dca951a2d12eff1665817\n</code></pre> <p>Note: It is recommended not to change this password manually, as it is securely generated.</p>"},{"location":"config/coder/#main-configuration-options","title":"Main Configuration Options","text":"<ul> <li><code>bind-addr</code>: The address and port code-server listens on (default: <code>127.0.0.1:8080</code>)</li> <li><code>auth</code>: Authentication method (default: <code>password</code>)</li> <li><code>password</code>: The login password (see above)</li> <li><code>cert</code>: Whether to use HTTPS (default: <code>false</code>)</li> </ul>"},{"location":"config/coder/#installed-tools-and-features","title":"Installed Tools and Features","text":"<p>The code-server environment includes:</p> <ul> <li>Node.js 18+ and npm</li> <li>Claude Code (<code>@anthropic-ai/claude-code</code>) globally installed</li> <li>Python 3 and tools:</li> <li><code>python3-pip</code>, <code>python3-venv</code>, <code>python3-full</code>, <code>pipx</code></li> <li>Image and PDF processing libraries:</li> <li><code>CairoSVG</code>, <code>Pillow</code>, <code>libcairo2-dev</code>, <code>libfreetype6-dev</code>, <code>libjpeg-dev</code>, <code>libpng-dev</code>, <code>libwebp-dev</code>, <code>libtiff5-dev</code>, <code>libopenjp2-7-dev</code>, <code>liblcms2-dev</code></li> <li><code>weasyprint</code>, <code>fonts-roboto</code></li> <li>Git for version control and plugin management</li> <li>Build tools: <code>build-essential</code>, <code>pkg-config</code>, <code>python3-dev</code>, <code>zlib1g-dev</code></li> <li>MkDocs Material and a wide range of MkDocs plugins, installed in a dedicated Python virtual environment at <code>/home/coder/.venv/mkdocs</code></li> <li>Convenience script: <code>run-mkdocs</code> for running MkDocs commands easily</li> </ul>"},{"location":"config/coder/#using-mkdocs","title":"Using MkDocs","text":"<p>The virtual environment for MkDocs is automatically added to your <code>PATH</code>. You can run MkDocs commands directly, or use the provided script. For example, to build the site, from a clean terminal we would rung:</p> <pre><code>cd mkdocs \nmkdocs build\n</code></pre>"},{"location":"config/coder/#claude-code-integration","title":"Claude Code Integration","text":"<p>The code-server environment comes with Claude Code (<code>@anthropic-ai/claude-code</code>) globally installed via npm.</p>"},{"location":"config/coder/#what-is-claude-code","title":"What is Claude Code?","text":"<p>Claude Code is an AI-powered coding assistant by Anthropic, designed to help you write, refactor, and understand code directly within your development environment.</p>"},{"location":"config/coder/#usage","title":"Usage","text":"<ul> <li>Access Claude Code features through the command palette or sidebar in code-server.</li> <li>Use Claude Code to generate code, explain code snippets, or assist with documentation and refactoring tasks.</li> <li>For more information, refer to the Claude Code documentation.</li> </ul> <p>Note: Claude Code requires an API key or account with Anthropic for full functionality. Refer to the extension settings for configuration.</p>"},{"location":"config/coder/#call-claude","title":"Call Claude","text":"<p>To use claude simply type claude into the terminal and follow instructions. </p> <pre><code>claude\n</code></pre>"},{"location":"config/coder/#shell-environment","title":"Shell Environment","text":"<p>The <code>.bashrc</code> is configured to include the MkDocs virtual environment and user-local binaries in your <code>PATH</code> for convenience.</p>"},{"location":"config/coder/#code-navigation-and-editing-features","title":"Code Navigation and Editing Features","text":"<p>The code-server environment provides robust code navigation and editing features, including:</p> <ul> <li>IntelliSense: Smart code completions based on variable types, function definitions, and imported modules.</li> <li>Code Navigation: Easily navigate to definitions, references, and symbol searches within your codebase.</li> <li>Debugging Support: Integrated debugging support for Node.js and Python, with breakpoints, call stacks, and interactive consoles.</li> <li>Terminal Access: Built-in terminal access to run commands, scripts, and version control operations.</li> </ul>"},{"location":"config/coder/#collaboration-features","title":"Collaboration Features","text":"<p>Code-server includes features to support collaboration:</p> <ul> <li>Live Share: Collaborate in real-time with others, sharing your code and terminal sessions.</li> <li>ChatGPT Integration: AI-powered code assistance and chat-based collaboration.</li> </ul>"},{"location":"config/coder/#security-considerations","title":"Security Considerations","text":"<p>When using code-server, consider the following security aspects:</p> <ul> <li>Password Management: The default password is securely generated. Do not share it or expose it in public repositories.</li> <li>Network Security: Ensure that your firewall settings allow access to the code-server port (default: 8080) only from trusted networks.</li> <li>Data Privacy: Be cautious when uploading sensitive data or code to the server. Use environment variables or secure vaults for sensitive information.</li> </ul>"},{"location":"config/coder/#ollama-integration","title":"Ollama Integration","text":"<p>The code-server environment includes Ollama, a tool for running large language models locally on your machine.</p>"},{"location":"config/coder/#what-is-ollama","title":"What is Ollama?","text":"<p>Ollama is a lightweight, extensible framework for building and running language models locally. It provides a simple API for creating, running, and managing models, making it easy to integrate AI capabilities into your development workflow without relying on external services.</p>"},{"location":"config/coder/#getting-started-with-ollama","title":"Getting Started with Ollama","text":""},{"location":"config/coder/#staring-ollama","title":"Staring Ollama","text":"<p>For ollama to be available, you need to open a terminal and run: </p> <pre><code>ollama serve\n</code></pre> <p>This will start the ollama server and you can then proceed to pulling a model and chatting. </p>"},{"location":"config/coder/#pulling-a-model","title":"Pulling a Model","text":"<p>To get started, you'll need to pull a model. For development and testing, we recommend starting with a smaller model like Gemma 2B:</p> <pre><code>ollama pull gemma2:2b\n</code></pre> <p>For even lighter resource usage, you can use the 1B parameter version:</p> <pre><code>ollama pull gemma2:1b\n</code></pre>"},{"location":"config/coder/#running-a-model","title":"Running a Model","text":"<p>Once you've pulled a model, you can start an interactive session:</p> <pre><code>ollama run gemma2:2b\n</code></pre>"},{"location":"config/coder/#available-models","title":"Available Models","text":"<p>Popular models available through Ollama include:</p> <ul> <li>Gemma 2 (1B, 2B, 9B, 27B): Google's efficient language models</li> <li>Llama 3.2 (1B, 3B, 11B, 90B): Meta's latest language models</li> <li>Qwen 2.5 (0.5B, 1.5B, 3B, 7B, 14B, 32B, 72B): Alibaba's multilingual models</li> <li>Phi 3.5 (3.8B): Microsoft's compact language model</li> <li>Code Llama (7B, 13B, 34B): Specialized for code generation</li> </ul>"},{"location":"config/coder/#using-ollama-in-your-development-workflow","title":"Using Ollama in Your Development Workflow","text":""},{"location":"config/coder/#api-access","title":"API Access","text":"<p>Ollama provides a REST API that runs on <code>http://localhost:11434</code> by default. You can integrate this into your applications:</p> <pre><code>curl http://localhost:11434/api/generate -d '{\n \"model\": \"gemma2:2b\",\n \"prompt\": \"Write a Python function to calculate fibonacci numbers\",\n \"stream\": false\n}'\n</code></pre>"},{"location":"config/coder/#model-management","title":"Model Management","text":"<p>List installed models: <pre><code>ollama list\n</code></pre></p> <p>Remove a model: <pre><code>ollama rm gemma2:2b\n</code></pre></p> <p>Show model information: <pre><code>ollama show gemma2:2b\n</code></pre></p>"},{"location":"config/coder/#resource-considerations","title":"Resource Considerations","text":"<ul> <li>1B models: Require ~1GB RAM, suitable for basic tasks and resource-constrained environments</li> <li>2B models: Require ~2GB RAM, good balance of capability and resource usage</li> <li>Larger models: Provide better performance but require significantly more resources</li> </ul>"},{"location":"config/coder/#integration-with-development-tools","title":"Integration with Development Tools","text":"<p>Ollama can be integrated with various development tools and editors through its API, enabling features like:</p> <ul> <li>Code completion and generation</li> <li>Documentation writing assistance</li> <li>Code review and explanation</li> <li>Automated testing suggestions</li> </ul> <p>For more information, visit the Ollama documentation.</p> <p>For more detailed information on configuring and using code-server, refer to the official code-server documentation.</p>"},{"location":"config/map/","title":"Map Configuration","text":"<p>The Map system is a containerized web application that visualizes geographic data from NocoDB on an interactive map using Leaflet.js. It's designed for canvassing applications and community organizing.</p>"},{"location":"config/map/#features","title":"Features","text":"<ul> <li>\ud83d\uddfa\ufe0f Interactive map visualization with OpenStreetMap</li> <li>\ud83d\udccd Real-time geolocation support for adding locations</li> <li>\u2795 Add new locations directly from the map interface</li> <li>\ud83d\udd04 Auto-refresh every 30 seconds</li> <li>\ud83d\udcf1 Responsive design for mobile devices</li> <li>\ud83d\udd12 Secure API proxy to protect NocoDB credentials</li> <li>\ud83d\udc64 User authentication with login system</li> <li>\u2699\ufe0f Admin panel for system configuration</li> <li>\ud83c\udfaf Configurable map start location</li> <li>\ud83d\udcc4 Walk Sheet generator for door-to-door canvassing</li> <li>\ud83d\udd17 QR code integration for digital resources</li> <li>\ud83d\udc33 Docker containerization for easy deployment</li> <li>\ud83c\udd93 100% open source (no proprietary dependencies)</li> </ul>"},{"location":"config/map/#setup-process-overview","title":"Setup Process Overview","text":"<p>The setup process involves several steps that must be completed in order:</p> <ol> <li>Get NocoDB API Token - Create an API token in your NocoDB instance</li> <li>Configure Environment - Update the <code>.env</code> file with your NocoDB details</li> <li>Auto-Create Database Structure - Run the build script to create required tables</li> <li>Get Table URLs - Find and copy the URLs for the newly created tables</li> <li>Update Environment with URLs - Add the table URLs to your <code>.env</code> file</li> <li>Build and Deploy - Build the Docker image and start the application</li> </ol>"},{"location":"config/map/#prerequisites","title":"Prerequisites","text":"<ul> <li>Docker and Docker Compose installed</li> <li>NocoDB instance with API access</li> <li>Domain name (optional but recommended for production)</li> </ul>"},{"location":"config/map/#step-1-get-nocodb-api-token","title":"Step 1: Get NocoDB API Token","text":"<ol> <li>Login to your NocoDB instance</li> <li>Click your user icon \u2192 Account Settings</li> <li>Go to the API Tokens tab</li> <li>Click Create new token</li> <li>Set the following permissions:</li> <li>Read: Yes</li> <li>Write: Yes</li> <li>Delete: Yes (optional, for admin functions)</li> <li>Copy the generated token - you'll need it for the next step</li> </ol> <p>Token Security</p> <p>Keep your API token secure and never commit it to version control. The token provides full access to your NocoDB data.</p>"},{"location":"config/map/#step-2-configure-environment","title":"Step 2: Configure Environment","text":"<p>Edit the <code>.env</code> file in the <code>map/</code> directory:</p> <pre><code># NocoDB API Configuration\nNOCODB_API_URL=https://your-nocodb-instance.com/api/v1\nNOCODB_API_TOKEN=your-api-token-here\n\n# These URLs will be populated after running build-nocodb.sh\nNOCODB_VIEW_URL=\nNOCODB_LOGIN_SHEET=\nNOCODB_SETTINGS_SHEET=\n\n# Server Configuration\nPORT=3000\nNODE_ENV=production\n\n# Session Secret (generate with: openssl rand -hex 32)\nSESSION_SECRET=your-secure-random-string\n\n# Map Defaults (Edmonton, Alberta, Canada)\nDEFAULT_LAT=53.5461\nDEFAULT_LNG=-113.4938\nDEFAULT_ZOOM=11\n\n# Optional: Map Boundaries (prevents users from adding points outside area)\n# BOUND_NORTH=53.7\n# BOUND_SOUTH=53.4\n# BOUND_EAST=-113.3\n# BOUND_WEST=-113.7\n\n# Production Settings\nTRUST_PROXY=true\nCOOKIE_DOMAIN=.yourdomain.com\nALLOWED_ORIGINS=https://map.yourdomain.com,http://localhost:3000\n</code></pre>"},{"location":"config/map/#required-configuration","title":"Required Configuration","text":"<ul> <li><code>NOCODB_API_URL</code>: Your NocoDB instance API URL (usually ends with <code>/api/v1</code>)</li> <li><code>NOCODB_API_TOKEN</code>: The token you created in Step 1</li> <li><code>SESSION_SECRET</code>: Generate a secure random string for session encryption</li> </ul>"},{"location":"config/map/#optional-configuration","title":"Optional Configuration","text":"<ul> <li><code>DEFAULT_LAT/LNG/ZOOM</code>: Default map center and zoom level</li> <li><code>BOUND_*</code>: Map boundaries to restrict where users can add points</li> <li><code>COOKIE_DOMAIN</code>: Your domain for cookie security</li> <li><code>ALLOWED_ORIGINS</code>: Comma-separated list of allowed origins for CORS</li> </ul>"},{"location":"config/map/#step-3-auto-create-database-structure","title":"Step 3: Auto-Create Database Structure","text":"<p>The <code>build-nocodb.sh</code> script will automatically create the required tables in your NocoDB instance.</p> <pre><code>cd map\nchmod +x build-nocodb.sh\n./build-nocodb.sh\n</code></pre>"},{"location":"config/map/#what-the-script-creates","title":"What the Script Creates","text":"<p>The script creates three tables with the following structure:</p>"},{"location":"config/map/#1-locations-table","title":"1. Locations Table","text":"<p>Main table for storing map data:</p> <ul> <li><code>Geo-Location</code> (Geo-Data): Format \"latitude;longitude\"</li> <li><code>latitude</code> (Decimal): Precision 10, Scale 8</li> <li><code>longitude</code> (Decimal): Precision 11, Scale 8</li> <li><code>First Name</code> (Single Line Text): Person's first name</li> <li><code>Last Name</code> (Single Line Text): Person's last name</li> <li><code>Email</code> (Email): Email address</li> <li><code>Phone</code> (Single Line Text): Phone number</li> <li><code>Unit Number</code> (Single Line Text): Unit or apartment number</li> <li><code>Address</code> (Single Line Text): Street address</li> <li><code>Support Level</code> (Single Select): Options: \"1\", \"2\", \"3\", \"4\"</li> <li>1 = Strong Support (Green)</li> <li>2 = Moderate Support (Yellow)</li> <li>3 = Low Support (Orange)</li> <li>4 = No Support (Red)</li> <li><code>Sign</code> (Checkbox): Has campaign sign</li> <li><code>Sign Size</code> (Single Select): Options: \"Regular\", \"Large\", \"Unsure\"</li> <li><code>Notes</code> (Long Text): Additional details and comments</li> </ul>"},{"location":"config/map/#2-login-table","title":"2. Login Table","text":"<p>User authentication table:</p> <ul> <li><code>Email</code> (Email): User email address (Primary)</li> <li><code>Name</code> (Single Line Text): User display name</li> <li><code>Admin</code> (Checkbox): Admin privileges</li> </ul>"},{"location":"config/map/#3-settings-table","title":"3. Settings Table","text":"<p>Admin configuration table:</p> <ul> <li><code>key</code> (Single Line Text): Setting identifier</li> <li><code>title</code> (Single Line Text): Display name</li> <li><code>value</code> (Long Text): Setting value</li> <li><code>Geo-Location</code> (Text): Format \"latitude;longitude\"</li> <li><code>latitude</code> (Decimal): Precision 10, Scale 8</li> <li><code>longitude</code> (Decimal): Precision 11, Scale 8</li> <li><code>zoom</code> (Number): Map zoom level</li> <li><code>category</code> (Single Select): Setting category</li> <li><code>updated_by</code> (Single Line Text): Last updater email</li> <li><code>updated_at</code> (DateTime): Last update time</li> <li><code>qr_code_1_image</code> (Attachment): QR code 1 image</li> <li><code>qr_code_2_image</code> (Attachment): QR code 2 image</li> <li><code>qr_code_3_image</code> (Attachment): QR code 3 image</li> </ul>"},{"location":"config/map/#default-data","title":"Default Data","text":"<p>The script also creates: - A default admin user (admin@example.com) - A default start location setting</p>"},{"location":"config/map/#step-4-get-table-urls","title":"Step 4: Get Table URLs","text":"<p>After the script completes successfully:</p> <ol> <li>Login to your NocoDB instance</li> <li>Navigate to your project (should be named \"Map Viewer Project\")</li> <li>For each table, get the view URL:</li> <li>Click on the table name</li> <li>Copy the URL from your browser's address bar</li> <li>The URL should look like: <code>https://your-nocodb.com/dashboard/#/nc/project-id/table-id</code></li> </ol> <p>You need URLs for: - Locations table \u2192 <code>NOCODB_VIEW_URL</code> - Login table \u2192 <code>NOCODB_LOGIN_SHEET</code> - Settings table \u2192 <code>NOCODB_SETTINGS_SHEET</code></p>"},{"location":"config/map/#step-5-update-environment-with-urls","title":"Step 5: Update Environment with URLs","text":"<p>Edit your <code>.env</code> file and add the table URLs:</p> <pre><code># Update these with the actual URLs from your NocoDB instance\nNOCODB_VIEW_URL=https://your-nocodb.com/dashboard/#/nc/project-id/locations-table-id\nNOCODB_LOGIN_SHEET=https://your-nocodb.com/dashboard/#/nc/project-id/login-table-id\nNOCODB_SETTINGS_SHEET=https://your-nocodb.com/dashboard/#/nc/project-id/settings-table-id\n</code></pre> <p>URL Format</p> <p>Make sure to use the complete dashboard URLs, not the API URLs. The application will automatically extract the project and table IDs from these URLs.</p>"},{"location":"config/map/#step-6-build-and-deploy","title":"Step 6: Build and Deploy","text":"<p>Build the Docker image and start the application:</p> <pre><code># Build the Docker image\ndocker-compose build\n\n# Start the application\ndocker-compose up -d\n</code></pre>"},{"location":"config/map/#verify-deployment","title":"Verify Deployment","text":"<ol> <li> <p>Check that the container is running: <pre><code>docker-compose ps\n</code></pre></p> </li> <li> <p>Check the logs: <pre><code>docker-compose logs -f map-viewer\n</code></pre></p> </li> <li> <p>Access the application at <code>http://localhost:3000</code> (or your configured domain)</p> </li> </ol>"},{"location":"config/map/#using-the-map-system","title":"Using the Map System","text":""},{"location":"config/map/#user-interface","title":"User Interface","text":""},{"location":"config/map/#main-map-view","title":"Main Map View","text":"<ul> <li>Interactive Map: Click and drag to navigate</li> <li>Add Location: Click on the map to add a new location</li> <li>Search: Use the search bar to find addresses</li> <li>Refresh: Data refreshes automatically every 30 seconds</li> </ul>"},{"location":"config/map/#location-markers","title":"Location Markers","text":"<ul> <li>Green: Strong Support (Level 1)</li> <li>Yellow: Moderate Support (Level 2)</li> <li>Orange: Low Support (Level 3)</li> <li>Red: No Support (Level 4)</li> </ul>"},{"location":"config/map/#adding-locations","title":"Adding Locations","text":"<ol> <li>Click on the map where you want to add a location</li> <li>Fill out the form with contact information</li> <li>Select support level and sign information</li> <li>Add any relevant notes</li> <li>Click \"Save Location\"</li> </ol>"},{"location":"config/map/#authentication","title":"Authentication","text":""},{"location":"config/map/#user-login","title":"User Login","text":"<ul> <li>Users must be added to the Login table in NocoDB</li> <li>Login with email address (no password required for simplified setup)</li> <li>Admin users have additional privileges</li> </ul>"},{"location":"config/map/#admin-access","title":"Admin Access","text":"<ul> <li>Admin users can access <code>/admin.html</code></li> <li>Configure map start location</li> <li>Set up walk sheet generator</li> <li>Manage QR codes and settings</li> </ul>"},{"location":"config/map/#admin-panel-features","title":"Admin Panel Features","text":""},{"location":"config/map/#start-location-configuration","title":"Start Location Configuration","text":"<ul> <li>Interactive Map: Visual interface for selecting coordinates</li> <li>Real-time Preview: See changes immediately</li> <li>Validation: Built-in coordinate and zoom level validation</li> </ul>"},{"location":"config/map/#walk-sheet-generator","title":"Walk Sheet Generator","text":"<ul> <li>Printable Forms: Generate 8.5x11 walk sheets for door-to-door canvassing</li> <li>QR Code Integration: Add up to 3 QR codes with custom URLs and labels</li> <li>Form Field Matching: Automatically matches fields from the main location form</li> <li>Live Preview: See changes as you type</li> <li>Print Optimization: Proper formatting for printing or PDF export</li> </ul>"},{"location":"config/map/#api-endpoints","title":"API Endpoints","text":""},{"location":"config/map/#public-endpoints","title":"Public Endpoints","text":"<ul> <li><code>GET /api/locations</code> - Fetch all locations (requires auth)</li> <li><code>POST /api/locations</code> - Create new location (requires auth)</li> <li><code>GET /api/locations/:id</code> - Get single location (requires auth)</li> <li><code>PUT /api/locations/:id</code> - Update location (requires auth)</li> <li><code>DELETE /api/locations/:id</code> - Delete location (requires auth)</li> <li><code>GET /api/config/start-location</code> - Get map start location</li> <li><code>GET /health</code> - Health check</li> </ul>"},{"location":"config/map/#authentication-endpoints","title":"Authentication Endpoints","text":"<ul> <li><code>POST /api/auth/login</code> - User login</li> <li><code>GET /api/auth/check</code> - Check authentication status</li> <li><code>POST /api/auth/logout</code> - User logout</li> </ul>"},{"location":"config/map/#admin-endpoints-requires-admin-privileges","title":"Admin Endpoints (requires admin privileges)","text":"<ul> <li><code>GET /api/admin/start-location</code> - Get start location with source info</li> <li><code>POST /api/admin/start-location</code> - Update map start location</li> <li><code>GET /api/admin/walk-sheet-config</code> - Get walk sheet configuration</li> <li><code>POST /api/admin/walk-sheet-config</code> - Save walk sheet configuration</li> </ul>"},{"location":"config/map/#troubleshooting","title":"Troubleshooting","text":""},{"location":"config/map/#common-issues","title":"Common Issues","text":""},{"location":"config/map/#locations-not-showing","title":"Locations not showing","text":"<ul> <li>Verify table has required columns (<code>Geo-Location</code>, <code>latitude</code>, <code>longitude</code>)</li> <li>Check that coordinates are valid numbers</li> <li>Ensure API token has read permissions</li> <li>Verify <code>NOCODB_VIEW_URL</code> is correct</li> </ul>"},{"location":"config/map/#cannot-add-locations","title":"Cannot add locations","text":"<ul> <li>Verify API token has write permissions</li> <li>Check browser console for errors</li> <li>Ensure coordinates are within valid ranges</li> <li>Verify user is authenticated</li> </ul>"},{"location":"config/map/#authentication-issues","title":"Authentication issues","text":"<ul> <li>Verify login table is properly configured</li> <li>Check that user email exists in Login table</li> <li>Ensure <code>NOCODB_LOGIN_SHEET</code> URL is correct</li> </ul>"},{"location":"config/map/#build-script-failures","title":"Build script failures","text":"<ul> <li>Check that <code>NOCODB_API_URL</code> and <code>NOCODB_API_TOKEN</code> are correct</li> <li>Verify NocoDB instance is accessible</li> <li>Check network connectivity</li> <li>Review script output for specific error messages</li> </ul>"},{"location":"config/map/#development-mode","title":"Development Mode","text":"<p>For development and debugging:</p> <pre><code>cd map/app\nnpm install\nnpm run dev\n</code></pre> <p>This will start the application with hot reload and detailed logging.</p>"},{"location":"config/map/#logs-and-monitoring","title":"Logs and Monitoring","text":"<p>View application logs: <pre><code>docker-compose logs -f map-viewer\n</code></pre></p> <p>Check health status: <pre><code>curl http://localhost:3000/health\n</code></pre></p>"},{"location":"config/map/#security-considerations","title":"Security Considerations","text":"<ol> <li>API Token Security: Keep tokens secure and rotate regularly</li> <li>HTTPS: Use HTTPS in production</li> <li>CORS Configuration: Set appropriate <code>ALLOWED_ORIGINS</code></li> <li>Cookie Security: Configure <code>COOKIE_DOMAIN</code> properly</li> <li>Input Validation: All inputs are validated server-side</li> <li>Rate Limiting: API endpoints have rate limiting</li> <li>Session Security: Use a strong <code>SESSION_SECRET</code></li> </ol>"},{"location":"config/map/#maintenance","title":"Maintenance","text":""},{"location":"config/map/#regular-updates","title":"Regular Updates","text":"<pre><code># Stop the application\ndocker-compose down\n\n# Pull updates (if using git)\ngit pull origin main\n\n# Rebuild and restart\ndocker-compose build\ndocker-compose up -d\n</code></pre>"},{"location":"config/map/#backup-considerations","title":"Backup Considerations","text":"<ul> <li>NocoDB data is stored in your NocoDB instance</li> <li>Back up your <code>.env</code> file securely</li> <li>Consider backing up QR code images from the Settings table</li> </ul>"},{"location":"config/map/#performance-tips","title":"Performance Tips","text":"<ul> <li>Monitor NocoDB performance and scaling</li> <li>Consider enabling caching for high-traffic deployments</li> <li>Use CDN for static assets if needed</li> <li>Monitor Docker container resource usage</li> </ul>"},{"location":"config/map/#support","title":"Support","text":"<p>For issues or questions: 1. Check the troubleshooting section above 2. Review NocoDB documentation 3. Check Docker and Docker Compose documentation 4. Open an issue on GitHub</p>"},{"location":"config/mkdocs/","title":"MkDocs Customization & Features Overview","text":"<p>BNKops has been building our own features, widgets, and css styles for MKdocs material theme. </p> <p>This document explains the custom styling, repository widgets, and key features enabled in this MkDocs site.</p> <p>For more info on how to build your site see Site Build</p>"},{"location":"config/mkdocs/#using-the-repository-widget-in-documentation","title":"Using the Repository Widget in Documentation","text":"<p>You can embed repository widgets directly in your Markdown documentation to display live repository stats and metadata. To do this, add a <code>div</code> with the appropriate class and <code>data-repo</code> attribute for the repository you want to display.</p> <p>Example (for a Gitea repository): <pre><code><div class=\"gitea-widget\" data-repo=\"admin/changemaker.lite\"></div>\n</code></pre></p> <p>This will render a styled card with information about the <code>admin/changemaker.lite</code> repository:</p> <p>Options: You can control the widget display with additional data attributes: - <code>data-show-description=\"false\"</code> \u2014 Hide the description - <code>data-show-language=\"false\"</code> \u2014 Hide the language - <code>data-show-last-update=\"false\"</code> \u2014 Hide the last update date</p> <p>Example with options: <pre><code><div class=\"gitea-widget\" data-repo=\"admin/changemaker.lite\" data-show-description=\"false\"></div>\n</code></pre></p> <p>For GitHub repositories, use the <code>github-widget</code> class: <pre><code><div class=\"github-widget\" data-repo=\"lyqht/mini-qr\"></div>\n</code></pre></p>"},{"location":"config/mkdocs/#custom-css-styling-stylesheetsextracss","title":"Custom CSS Styling (<code>stylesheets/extra.css</code>)","text":"<p>The <code>extra.css</code> file provides extensive custom styling for the site, including:</p> <ul> <li> <p>Login and Git Code Buttons: Custom styles for <code>.login-button</code> and <code>.git-code-button</code> to create visually distinct, modern buttons with hover effects.</p> </li> <li> <p>Code Block Improvements: Forces code blocks to wrap text (<code>white-space: pre-wrap</code>) and ensures inline code and tables with code display correctly on all devices.</p> </li> <li> <p>GitHub Widget Styles: Styles for <code>.github-widget</code> and its subcomponents, including:</p> </li> <li>Card-like container with gradient backgrounds and subtle box-shadows.</li> <li>Header with icon, repo link, and stats (stars, forks, issues).</li> <li>Description area with accent border.</li> <li>Footer with language, last update, and license info.</li> <li>Loading and error states with spinners and error messages.</li> <li>Responsive grid layout for multiple widgets.</li> <li>Compact variant for smaller displays.</li> <li> <p>Dark mode adjustments.</p> </li> <li> <p>Gitea Widget Styles: Similar to GitHub widget, but with Gitea branding (green accents). Includes <code>.gitea-widget</code>, <code>.gitea-widget-container</code>, and related classes for header, stats, description, footer, loading, and error states.</p> </li> <li> <p>Responsive Design: Media queries ensure widgets and tables look good on mobile devices.</p> </li> </ul>"},{"location":"config/mkdocs/#repository-widgets","title":"Repository Widgets","text":""},{"location":"config/mkdocs/#data-generation-hooksrepo_widget_hookpy","title":"Data Generation (<code>hooks/repo_widget_hook.py</code>)","text":"<ul> <li>Purpose: During the MkDocs build, this hook fetches metadata for a list of GitHub and Gitea repositories and writes JSON files to <code>docs/assets/repo-data/</code>.</li> <li>How it works:</li> <li>Runs before build (unless in <code>serve</code> mode).</li> <li>Fetches repo data (stars, forks, issues, language, etc.) via GitHub/Gitea APIs.</li> <li>Outputs a JSON file per repo (e.g., <code>lyqht-mini-qr.json</code>).</li> <li>Used by frontend widgets for fast, client-side rendering.</li> </ul>"},{"location":"config/mkdocs/#github-widget-javascriptsgithub-widgetjs","title":"GitHub Widget (<code>javascripts/github-widget.js</code>)","text":"<ul> <li>Purpose: Renders a card for each GitHub repository using the pre-generated JSON data.</li> <li>Features:</li> <li>Displays repo name, link, stars, forks, open issues, language, last update, and license.</li> <li>Shows loading spinner while fetching data.</li> <li>Handles errors gracefully.</li> <li>Supports dynamic content (re-initializes on DOM changes).</li> <li>Language color coding for popular languages.</li> </ul>"},{"location":"config/mkdocs/#gitea-widget-javascriptsgitea-widgetjs","title":"Gitea Widget (<code>javascripts/gitea-widget.js</code>)","text":"<ul> <li>Purpose: Renders a card for each Gitea repository using the pre-generated JSON data.</li> <li>Features:</li> <li>Similar to GitHub widget, but styled for Gitea.</li> <li>Shows repo name, link, stars, forks, open issues, language, last update.</li> <li>Loading and error states.</li> <li>Language color coding.</li> </ul>"},{"location":"config/mkdocs/#mkdocs-features-mkdocsyml","title":"MkDocs Features (<code>mkdocs.yml</code>)","text":"<p>Key features and plugins enabled:</p> <ul> <li> <p>Material Theme: Modern, responsive UI with dark/light mode toggle, custom fonts, and accent colors.</p> </li> <li> <p>Navigation Enhancements: </p> </li> <li>Tabs, sticky navigation, instant loading, breadcrumbs, and sectioned navigation.</li> <li> <p>Table of contents with permalinks.</p> </li> <li> <p>Content Features: </p> </li> <li>Code annotation, copy buttons, tooltips, and improved code highlighting.</li> <li> <p>Admonitions, tabbed content, task lists, and emoji support.</p> </li> <li> <p>Plugins:</p> </li> <li>Search: Advanced search with custom tokenization.</li> <li>Social: OpenGraph/social card generation.</li> <li>Blog: Blogging support with archives and categories.</li> <li> <p>Tags: Tagging for content organization.</p> </li> <li> <p>Custom Hooks: </p> </li> <li> <p><code>repo_widget_hook.py</code> for repository widget data.</p> </li> <li> <p>Extra CSS/JS: </p> </li> <li> <p>Custom styles and scripts for widgets and homepage.</p> </li> <li> <p>Extra Configuration: </p> </li> <li>Social links, copyright.</li> </ul>"},{"location":"config/mkdocs/#summary","title":"Summary","text":"<p>This MkDocs site is highly customized for developer documentation, with visually rich repository widgets, improved code and table rendering, and a modern, responsive UI. All repository stats are fetched at build time for performance and reliability.</p>"},{"location":"how%20to/canvass/","title":"Canvas","text":"<p>This is BNKops canvassing how to! In the following document, you will find all sorts of tips and tricks for door knocking, canvassing, and using the BNKops canvassing app.</p>"},{"location":"manual/","title":"Manuals","text":"<p>The following are manuals, some accompanied by videos, on the use of the system. </p>"},{"location":"manual/map/","title":"Map Viewer Manual","text":"<p>This manual provides step-by-step instructions for using the NocoDB Map Viewer web application. Each section covers a major feature with direct instructions. (Insert screenshot - feature overview)</p>"},{"location":"manual/map/#1-logging-in","title":"1. Logging In","text":"<ol> <li>Go to the map site URL (e.g., http://localhost:3000).</li> <li>Enter your email and password on the login page.</li> <li>Click Login.</li> <li>If you forget your password, contact an admin. (Insert screenshot - login page)</li> </ol>"},{"location":"manual/map/#2-viewing-the-map","title":"2. Viewing the Map","text":"<ol> <li>After login, you will see the interactive map.</li> <li>Use your mouse or touch to pan and zoom.</li> <li>Your current location may be shown as a blue dot. (Insert screenshot - main map view)</li> </ol>"},{"location":"manual/map/#3-adding-a-new-location","title":"3. Adding a New Location","text":"<ol> <li>Click the Add Location button (usually a plus icon on the map).</li> <li>Click on the map where you want to add the new location.</li> <li>Fill out the form:</li> <li>First Name, Last Name, Email, Phone, Unit Number, Support Level, Address, Sign, Sign Size, Notes.</li> <li>Click Save.</li> <li>The new location will appear as a marker on the map. (Insert screenshot - add location form)</li> </ol>"},{"location":"manual/map/#4-editing-or-deleting-a-location","title":"4. Editing or Deleting a Location","text":"<ol> <li>Click on a location marker.</li> <li>In the popup, click Edit to update details, or Delete to remove the location.</li> <li>Confirm your changes. (Insert screenshot - location popup with edit/delete)</li> </ol>"},{"location":"manual/map/#5-auto-refresh","title":"5. Auto-Refresh","text":"<p>The map automatically refreshes every 30 seconds to show the latest data. (Insert screenshot - refresh indicator)</p>"},{"location":"manual/map/#6-map-start-location-boundaries","title":"6. Map Start Location & Boundaries","text":"<ol> <li>The map opens to the default start location (Edmonton, Canada, unless changed by admin).</li> <li>Admins can set boundaries to restrict where points can be added. (Insert screenshot - map boundaries)</li> </ol>"},{"location":"manual/map/#7-walk-sheet-generator","title":"7. Walk Sheet Generator","text":"<ol> <li>Go to the Walk Sheet section (usually in the admin panel).</li> <li>Enter the title, subtitle, footer, and QR code info.</li> <li>Click Generate to create a printable walk sheet.</li> <li>Download or print the sheet. (Insert screenshot - walk sheet generator)</li> </ol>"},{"location":"manual/map/#8-qr-code-integration","title":"8. QR Code Integration","text":"<ol> <li>QR codes can be added to walk sheets for quick access to digital resources.</li> <li>Enter the URL and label for each QR code in the settings.</li> <li>QR codes will appear on the generated walk sheet. (Insert screenshot - QR code on walk sheet)</li> </ol>"},{"location":"manual/map/#9-volunteer-shift-management","title":"9. Volunteer Shift Management","text":""},{"location":"manual/map/#for-all-users","title":"For All Users","text":"<ol> <li>Go to Shifts (http://localhost:3000/shifts.html).</li> <li>View shifts in Grid or Calendar view.</li> <li>Click a shift to see details.</li> <li>Click Sign Up to join a shift.</li> <li>Your signed-up shifts are shown at the top. (Insert screenshot - shifts grid and calendar)</li> </ol>"},{"location":"manual/map/#cancel-a-signup","title":"Cancel a Signup","text":"<ol> <li>Click Cancel next to a shift you signed up for.</li> <li>Confirm cancellation. (Insert screenshot - cancel signup)</li> </ol>"},{"location":"manual/map/#calendar-color-codes","title":"Calendar Color Codes","text":"<ul> <li>Green: Shifts you signed up for</li> <li>Blue: Available shifts</li> <li>Gray: Full shifts</li> </ul>"},{"location":"manual/map/#10-admin-features","title":"10. Admin Features","text":""},{"location":"manual/map/#shift-management","title":"Shift Management","text":"<ol> <li>Go to Admin Panel (http://localhost:3000/admin.html).</li> <li>Create, edit, or cancel shifts.</li> <li>View all signups and manage volunteers. (Insert screenshot - admin shift management)</li> </ol>"},{"location":"manual/map/#user-management","title":"User Management","text":"<ol> <li>In the admin panel, go to User Management.</li> <li>Add new users with email, password, and role (admin/user).</li> <li>Delete users as needed. (Insert screenshot - user management panel)</li> </ol>"},{"location":"manual/map/#map-start-location","title":"Map Start Location","text":"<ol> <li>In the admin panel, go to Start Location.</li> <li>Select coordinates and zoom level.</li> <li>Save changes to update the map default. (Insert screenshot - start location config)</li> </ol>"},{"location":"manual/map/#walk-sheet-config","title":"Walk Sheet Config","text":"<ol> <li>In the admin panel, go to Walk Sheet Config.</li> <li>Edit walk sheet fields and QR codes.</li> <li>Save to persist changes. (Insert screenshot - walk sheet config panel)</li> </ol>"},{"location":"manual/map/#11-troubleshooting","title":"11. Troubleshooting","text":"<ul> <li>Locations not showing: Check that location data includes latitude/longitude and your API token has read permissions.</li> <li>Cannot add locations: Ensure your API token has write permissions and coordinates are valid.</li> <li>Connection errors: Verify NocoDB is accessible and API URL is correct.</li> <li>Build script issues: Make sure your NocoDB database is clean and API token has admin permissions.</li> </ul>"},{"location":"manual/map/#12-security-privacy","title":"12. Security & Privacy","text":"<ul> <li>All API tokens are kept server-side only.</li> <li>CORS and rate limiting are enabled.</li> <li>Input validation and security headers are enforced.</li> </ul>"},{"location":"manual/map/#13-support","title":"13. Support","text":"<p>For help, check the troubleshooting section, review NocoDB docs, or contact your admin. (Insert screenshot - help section)</p>"},{"location":"phil/","title":"Philosophy: Your Secrets, Your Power, Your Movement","text":""},{"location":"phil/#the-question-that-changes-everything","title":"The Question That Changes Everything!","text":"<p>If you are a political actor, who do you trust with your secrets?</p> <p>This isn't just a technical question\u2014it's the core political question of our time. Every email you send, every document you create, every contact list you build, every strategy you develop: where does it live? Who owns the servers? Who has the keys?</p>"},{"location":"phil/#the-corporate-extraction-machine","title":"The Corporate Extraction Machine","text":""},{"location":"phil/#how-they-hook-you","title":"How They Hook You","text":"<p>Corporate software companies have perfected the art of digital snake oil sales:</p> <ol> <li>Free Trials - They lure you in with \"free\" accounts</li> <li>Feature Creep - Essential features require paid tiers </li> <li>Data Lock-In - Your data becomes harder to export</li> <li>Price Escalation - $40/month becomes $750/month as you grow</li> <li>Surveillance Integration - Your organizing becomes their intelligence</li> </ol>"},{"location":"phil/#the-real-product","title":"The Real Product","text":"<p>You Are Not the Customer</p> <p>If you're not paying for the product, you ARE the product. But even when you are paying, you're often still the product.</p> <p>Corporate platforms don't make money from your subscription fees\u2014they make money from:</p> <ul> <li>Data Sales to third parties</li> <li>Algorithmic Manipulation for corporate and political interests </li> <li>Surveillance Contracts with governments and corporations</li> <li>Predictive Analytics about your community and movement</li> </ul>"},{"location":"phil/#the-bnkops-alternative","title":"The BNKops Alternative","text":""},{"location":"phil/#who-we-are","title":"Who We Are","text":"<p>BNKops is a cooperative based in amiskwaciy-w\u00e2skahikan (Edmonton, Alberta) on Treaty 6 territory. We're not a corporation\u2014we're a collective of skilled organizers, developers, and community builders who believe technology should serve liberation, not oppression.</p>"},{"location":"phil/#our-principles","title":"Our Principles","text":""},{"location":"phil/#liberation-first","title":"\ud83c\udff3\ufe0f\u200d\u26a7\ufe0f \ud83c\udff3\ufe0f\u200d\ud83c\udf08 \ud83c\uddf5\ud83c\uddf8 Liberation First","text":"<p>Technology that centers the most marginalized voices and fights for collective liberation. We believe strongly that the medium is the message; if you the use the medium of fascists, what does that say about your movement? </p>"},{"location":"phil/#community-over-profit","title":"\ud83e\udd1d Community Over Profit","text":"<p>We operate as a cooperative because we believe in shared ownership and democratic decision-making. No venture capitalists, no shareholders, no extraction.</p>"},{"location":"phil/#data-sovereignty","title":"\u26a1 Data Sovereignty","text":"<p>Your data belongs to you and your community. We build tools that let you own your digital infrastructure completely.</p>"},{"location":"phil/#security-culture","title":"\ud83d\udd12 Security Culture","text":"<p>Real security comes from community control, not corporate promises. We integrate security culture practices into our technology design.</p>"},{"location":"phil/#the-changemaker-difference","title":"The Changemaker Difference","text":""},{"location":"phil/#traditional-corporate-flow","title":"Traditional Corporate Flow","text":"<pre><code>Your Data \u2192 Corporate Server \u2192 Surveillance \u2192 Profit \u2192 Your Oppression\n</code></pre>"},{"location":"phil/#changemaker-flow","title":"Changemaker Flow","text":"<pre><code>Your Data \u2192 Your Server \u2192 Your Community \u2192 Your Power \u2192 Liberation\n</code></pre>"},{"location":"phil/#why-this-matters","title":"Why This Matters","text":"<p>When you control your technology infrastructure:</p> <ul> <li>Your secrets stay secret - No corporate access to sensitive organizing data</li> <li>Your community stays connected - No algorithmic manipulation of your reach</li> <li>Your costs stay low - No extraction-based pricing as you grow</li> <li>Your future stays yours - No vendor lock-in or platform dependency</li> </ul>"},{"location":"phil/#the-philosophy-in-practice","title":"The Philosophy in Practice","text":""},{"location":"phil/#security-culture-meets-technology","title":"Security Culture Meets Technology","text":"<p>Traditional security culture asks: \"Who needs to know this information?\" </p> <p>Digital security culture asks: \"Who controls the infrastructure where this information lives?\"</p>"},{"location":"phil/#community-technology","title":"Community Technology","text":"<p>We believe in community technology - tools that:</p> <ul> <li>Are owned and controlled by the communities that use them</li> <li>Are designed with liberation politics from the ground up</li> <li>Prioritize care, consent, and collective power</li> <li>Can be understood, modified, and improved by community members</li> </ul>"},{"location":"phil/#prefigurative-politics","title":"Prefigurative Politics","text":"<p>The tools we use shape the movements we build. Corporate tools create corporate movements\u2014hierarchical, surveilled, and dependent. Community-controlled tools create community-controlled movements\u2014democratic, secure, and sovereign.</p>"},{"location":"phil/#common-questions","title":"Common Questions","text":""},{"location":"phil/#isnt-this-just-for-tech-people","title":"\"Isn't this just for tech people?\"","text":"<p>No. We specifically designed Changemaker Lite for organizers, activists, and movement builders who may not have technical backgrounds. Our philosophy is that everyone deserves digital sovereignty, not just people with computer science degrees.</p> <p>This is not to say that you won't need to learn! These tools are just that; tools. They have no fancy or white-labeled marketing and are technical in nature. You will need to learn to use them, just as any worker needs to learn the power tools they use on the job. </p>"},{"location":"phil/#what-about-convenience","title":"\"What about convenience?\"","text":"<p>Corporate platforms are convenient because they've extracted billions of dollars from users to fund that convenience. When you own your tools, there's a learning curve\u2014but it's the same learning curve as learning to organize, learning to build power, learning to create change.</p>"},{"location":"phil/#cant-we-just-use-corporate-tools-carefully","title":"\"Can't we just use corporate tools carefully?\"","text":"<p>Would you hold your most sensitive organizing meetings in a room owned by your opposition? Would you store your membership lists in filing cabinets at a corporation that profits from surveillance? Digital tools are the same.</p>"},{"location":"phil/#what-about-security","title":"\"What about security?\"","text":"<p>Real security comes from community control, not corporate promises. When you control your infrastructure:</p> <ul> <li>You decide what gets logged and what doesn't</li> <li>You choose who has access and who doesn't </li> <li>You know exactly where your data is and who can see it</li> <li>You can't be de-platformed or locked out of your own data</li> </ul>"},{"location":"phil/#historical-context","title":"Historical Context","text":""},{"location":"phil/#learning-from-past-struggles","title":"Learning from Past Struggles","text":"<p>Every liberation movement has had to solve the problem of secure communication and information sharing:</p> <ul> <li>Underground Railroad - Coded songs and safe houses</li> <li>Labor Movement - Secret meetings and encrypted telegrams </li> <li>Civil Rights Movement - CB radios and phone trees</li> <li>LGBTQ+ Liberation - Chosen families and community networks</li> </ul> <p>The internet should expand these traditions, not replace them with corporate surveillance.</p>"},{"location":"phil/#the-surveillance-capitalism-trap","title":"The Surveillance Capitalism Trap","text":"<p>As Shoshana Zuboff documents in \"The Age of Surveillance Capitalism,\" we're living through a new form of capitalism that extracts value from human experience itself. Political movements are particularly valuable targets because:</p> <ul> <li>Political data predicts behavior</li> <li>Movement intelligence can be used to counter-organize</li> <li>Community networks can be mapped and disrupted</li> <li>Organizing strategies can be monitored and neutralized</li> </ul>"},{"location":"phil/#taking-action","title":"Taking Action","text":""},{"location":"phil/#start-where-you-are","title":"Start Where You Are","text":"<p>You don't have to replace everything at once. Start with one tool, one campaign, one project. Learn the technology alongside your organizing.</p>"},{"location":"phil/#build-community-capacity","title":"Build Community Capacity","text":"<p>The goal isn't individual self-sufficiency\u2014it's community technological sovereignty. Share skills, pool resources, learn together.</p>"},{"location":"phil/#connect-with-others","title":"Connect with Others","text":"<p>You're not alone in this. The free and open source software community, the digital security community, and the appropriate technology movement are all working on similar problems.</p>"},{"location":"phil/#remember-why","title":"Remember Why","text":"<p>This isn't about technology for its own sake. It's about building the infrastructure for the world we want to see\u2014where communities have power, where people control their own data, where technology serves liberation.</p>"},{"location":"phil/#resources-for-deeper-learning","title":"Resources for Deeper Learning","text":""},{"location":"phil/#essential-reading","title":"Essential Reading","text":"<ul> <li>De-corp Your Software Stack - Our full manifesto</li> <li>The Age of Surveillance Capitalism by Shoshana Zuboff</li> <li>Security Culture Handbook</li> </ul>"},{"location":"phil/#community-resources","title":"Community Resources","text":"<ul> <li>BNKops Repository - Documentation and knowledge base</li> <li>Activist Handbook - Movement building resources</li> <li>EFF Surveillance Self-Defense - Digital security guides</li> </ul>"},{"location":"phil/#technical-learning","title":"Technical Learning","text":"<ul> <li>Self-Hosted Awesome List - Open source alternatives</li> <li>Linux Journey - Learn Linux basics</li> <li>Docker Curriculum - Learn containerization</li> </ul> <p>This philosophy document is a living document. Contribute your thoughts, experiences, and improvements through the BNKops documentation platform.</p>"},{"location":"phil/cost-comparison/","title":"Cost Comparison: Corporation vs. Community","text":""},{"location":"phil/cost-comparison/#the-true-cost-of-corporate-dependency","title":"The True Cost of Corporate Dependency","text":"<p>When movements choose corporate software, they're not just paying subscription fees\u2014they're paying with their power, their privacy, and their future. Let's break down the real costs.</p>"},{"location":"phil/cost-comparison/#monthly-cost-analysis","title":"Monthly Cost Analysis","text":""},{"location":"phil/cost-comparison/#small-campaign-50-supporters-5000-emailsmonth","title":"Small Campaign (50 supporters, 5,000 emails/month)","text":"Service Category Corporate Solution Monthly Cost Changemaker Lite Monthly Cost Email Marketing Mailchimp $59/month Listmonk $0* Database & CRM Airtable Pro $240/month NocoDB $0* Website Hosting Squarespace $40/month Static Server $0* Documentation Notion Team $96/month MkDocs $0* Development GitHub Codespaces $87/month Code Server $0* Automation Zapier Professional $73/month n8n $0* File Storage Google Workspace $72/month PostgreSQL + Storage $0* Analytics Corporate tracking Privacy cost\u2020 Self-hosted $0* TOTAL $667/month $50/month <p>*Included in base Changemaker Lite hosting cost \u2020Privacy costs are incalculable but include surveillance, data sales, and community manipulation</p>"},{"location":"phil/cost-comparison/#medium-campaign-500-supporters-50000-emailsmonth","title":"Medium Campaign (500 supporters, 50,000 emails/month)","text":"Service Category Corporate Solution Monthly Cost Changemaker Lite Monthly Cost Email Marketing Mailchimp $299/month Listmonk $0* Database & CRM Airtable Pro $600/month NocoDB $0* Website Hosting Squarespace $65/month Static Server $0* Documentation Notion Team $240/month MkDocs $0* Development GitHub Codespaces $174/month Code Server $0* Automation Zapier Professional $146/month n8n $0* File Storage Google Workspace $144/month PostgreSQL + Storage $0* Analytics Corporate tracking Privacy cost\u2020 Self-hosted $0* TOTAL $1,668/month $75/month"},{"location":"phil/cost-comparison/#large-campaign-5000-supporters-500000-emailsmonth","title":"Large Campaign (5,000 supporters, 500,000 emails/month)","text":"Service Category Corporate Solution Monthly Cost Changemaker Lite Monthly Cost Email Marketing Mailchimp $1,499/month Listmonk $0* Database & CRM Airtable Pro $1,200/month NocoDB $0* Website Hosting Squarespace + CDN $120/month Static Server $0* Documentation Notion Team $480/month MkDocs $0* Development GitHub Codespaces $348/month Code Server $0* Automation Zapier Professional $292/month n8n $0* File Storage Google Workspace $288/month PostgreSQL + Storage $0* Analytics Corporate tracking Privacy cost\u2020 Self-hosted $0* TOTAL $4,227/month $150/month"},{"location":"phil/cost-comparison/#annual-savings-breakdown","title":"Annual Savings Breakdown","text":""},{"location":"phil/cost-comparison/#3-year-cost-comparison","title":"3-Year Cost Comparison","text":"Campaign Size Corporate Total Changemaker Total Savings Small $24,012 $1,800 $22,212 Medium $60,048 $2,700 $57,348 Large $152,172 $5,400 $146,772"},{"location":"phil/cost-comparison/#hidden-costs-of-corporate-software","title":"Hidden Costs of Corporate Software","text":""},{"location":"phil/cost-comparison/#what-you-cant-put-a-price-on","title":"What You Can't Put a Price On","text":""},{"location":"phil/cost-comparison/#privacy-violations","title":"Privacy Violations","text":"<ul> <li>Data Harvesting: Every interaction monitored and stored</li> <li>Behavioral Profiling: Your community mapped and analyzed </li> <li>Third-Party Sales: Your data sold to unknown entities</li> <li>Government Access: Warrantless surveillance through corporate partnerships</li> </ul>"},{"location":"phil/cost-comparison/#political-manipulation","title":"Political Manipulation","text":"<ul> <li>Algorithmic Suppression: Your content reach artificially limited</li> <li>Narrative Control: Corporate interests shape what your community sees</li> <li>Shadow Banning: Activists systematically de-platformed</li> <li>Counter-Intelligence: Your strategies monitored by opposition</li> </ul>"},{"location":"phil/cost-comparison/#movement-disruption","title":"Movement Disruption","text":"<ul> <li>Dependency Creation: Critical infrastructure controlled by adversaries</li> <li>Community Fragmentation: Platforms designed to extract attention, not build power</li> <li>Organizing Interference: Corporate algorithms prioritize engagement over solidarity</li> <li>Cultural Assimilation: Movement culture shaped by corporate values</li> </ul>"},{"location":"phil/cost-comparison/#the-changemaker-advantage","title":"The Changemaker Advantage","text":""},{"location":"phil/cost-comparison/#what-you-get-for-50-150month","title":"What You Get for $50-150/month","text":""},{"location":"phil/cost-comparison/#complete-infrastructure","title":"Complete Infrastructure","text":"<ul> <li>Email System: Unlimited contacts, unlimited sends</li> <li>Database Power: Unlimited records, unlimited complexity</li> <li>Web Presence: Unlimited sites, unlimited traffic</li> <li>Development Environment: Full coding environment with AI assistance</li> <li>Documentation Platform: Beautiful, searchable knowledge base</li> <li>Automation Engine: Connect everything, automate everything</li> <li>File Storage: Unlimited files, unlimited backups</li> </ul>"},{"location":"phil/cost-comparison/#true-ownership","title":"True Ownership","text":"<ul> <li>Your Domain: No corporate branding or limitations</li> <li>Your Data: Complete export capability, no lock-in</li> <li>Your Rules: No terms of service to violate</li> <li>Your Community: No algorithmic manipulation</li> </ul>"},{"location":"phil/cost-comparison/#community-support","title":"Community Support","text":"<ul> <li>Open Documentation: Complete guides and tutorials available</li> <li>Community-Driven Development: Built by and for liberation movements</li> <li>Technical Support: Professional assistance from BNKops cooperative</li> <li>Political Alignment: Technology designed with movement values</li> </ul>"},{"location":"phil/cost-comparison/#the-compound-effect","title":"The Compound Effect","text":""},{"location":"phil/cost-comparison/#year-over-year-savings","title":"Year Over Year Savings","text":"<p>Corporate software costs grow exponentially: - Year 1: \"Starter\" pricing to hook you - Year 2: Feature limits force tier upgrades - Year 3: Usage growth triggers premium pricing - Year 4: Platform changes force expensive migrations - Year 5: Lock-in enables arbitrary price increases</p> <p>Changemaker Lite costs grow linearly with actual infrastructure needs: - Year 1: Base infrastructure costs - Year 2: Modest increases for storage/bandwidth only - Year 3: Scale only with actual technical requirements - Year 4: Community-driven improvements at no extra cost - Year 5: Established infrastructure with declining per-user costs</p>"},{"location":"phil/cost-comparison/#10-year-projection","title":"10-Year Projection","text":"Year Corporate (Medium Campaign) Changemaker Lite Annual Savings 1 $20,016 $900 $19,116 2 $22,017 $900 $21,117 3 $24,219 $1,080 $23,139 4 $26,641 $1,080 $25,561 5 $29,305 $1,260 $28,045 6 $32,235 $1,260 $30,975 7 $35,459 $1,440 $34,019 8 $39,005 $1,440 $37,565 9 $42,905 $1,620 $41,285 10 $47,196 $1,620 $45,576 TOTAL $318,998 $12,600 $306,398"},{"location":"phil/cost-comparison/#calculate-your-own-savings","title":"Calculate Your Own Savings","text":""},{"location":"phil/cost-comparison/#current-corporate-costs-worksheet","title":"Current Corporate Costs Worksheet","text":"<p>Email Marketing: $____/month Database/CRM: $____/month Website Hosting: $____/month Documentation: $____/month Development Tools: $____/month Automation: $____/month File Storage: $____/month Other SaaS: $____/month </p> <p>Monthly Total: $____ Annual Total: $____ </p> <p>Changemaker Alternative: $50-150/month Your Annual Savings: $____</p>"},{"location":"phil/cost-comparison/#beyond-the-numbers","title":"Beyond the Numbers","text":""},{"location":"phil/cost-comparison/#what-movements-do-with-their-savings","title":"What Movements Do With Their Savings","text":"<p>The money saved by choosing community-controlled technology doesn't disappear\u2014it goes directly back into movement building:</p> <ul> <li>Hire organizers instead of paying corporate executives</li> <li>Fund direct actions instead of funding surveillance infrastructure </li> <li>Support community members instead of enriching shareholders</li> <li>Build lasting power instead of temporary platform dependency</li> </ul>"},{"location":"phil/cost-comparison/#making-the-switch","title":"Making the Switch","text":""},{"location":"phil/cost-comparison/#transition-strategy","title":"Transition Strategy","text":"<p>You don't have to switch everything at once:</p> <ol> <li>Start with documentation - Move your knowledge base to MkDocs</li> <li>Add email infrastructure - Set up Listmonk for newsletters</li> <li>Build your database - Move contact management to NocoDB</li> <li>Automate connections - Use n8n to integrate everything</li> <li>Phase out corporate tools - Cancel subscriptions as you replicate functionality</li> </ol>"},{"location":"phil/cost-comparison/#investment-timeline","title":"Investment Timeline","text":"<ul> <li>Month 1: Initial setup and learning ($150 including setup time)</li> <li>Month 2-3: Data migration and team training ($100/month)</li> <li>Month 4+: Full operation at optimal cost ($50-150/month based on scale)</li> </ul>"},{"location":"phil/cost-comparison/#roi-calculation","title":"ROI Calculation","text":"<p>Most campaigns recover their entire first-year investment in 60-90 days through subscription savings alone.</p> <p>Ready to stop feeding your budget to corporate surveillance? Get started with Changemaker Lite today and take control of your digital infrastructure.</p>"},{"location":"services/","title":"Services","text":"<p>Changemaker Lite includes several powerful services that work together to provide a complete documentation and development platform. Each service is containerized and can be accessed through its dedicated port.</p>"},{"location":"services/#available-services","title":"Available Services","text":""},{"location":"services/#code-server","title":"Code Server","text":"<p>Port: 8888 | Visual Studio Code in your browser for remote development</p> <ul> <li>Full IDE experience</li> <li>Extensions support</li> <li>Git integration</li> <li>Terminal access</li> </ul>"},{"location":"services/#listmonk","title":"Listmonk","text":"<p>Port: 9000 | Self-hosted newsletter and mailing list manager</p> <ul> <li>Email campaigns</li> <li>Subscriber management</li> <li>Analytics</li> <li>Template system</li> </ul>"},{"location":"services/#postgresql","title":"PostgreSQL","text":"<p>Port: 5432 | Reliable database backend - Data persistence for Listmonk - ACID compliance - High performance - Backup and restore capabilities</p>"},{"location":"services/#mkdocs-material","title":"MkDocs Material","text":"<p>Port: 4000 | Documentation site generator with live preview</p> <ul> <li>Material Design theme</li> <li>Live reload</li> <li>Search functionality</li> <li>Markdown support</li> </ul>"},{"location":"services/#static-site-server","title":"Static Site Server","text":"<p>Port: 4001 | Nginx-powered static site hosting - High-performance serving - Built documentation hosting - Caching and compression - Security headers</p>"},{"location":"services/#n8n","title":"n8n","text":"<p>Port: 5678 | Workflow automation tool</p> <ul> <li>Visual workflow editor</li> <li>400+ integrations</li> <li>Custom code execution</li> <li>Webhook support</li> </ul>"},{"location":"services/#nocodb","title":"NocoDB","text":"<p>Port: 8090 | No-code database platform</p> <ul> <li>Smart spreadsheet interface</li> <li>Form builder and API generation</li> <li>Real-time collaboration</li> <li>Multi-database support</li> </ul>"},{"location":"services/#homepage","title":"Homepage","text":"<p>Port: 3010 | Modern dashboard for all services</p> <ul> <li>Service dashboard and monitoring</li> <li>Docker integration</li> <li>Customizable layout</li> <li>Quick search and bookmarks</li> </ul>"},{"location":"services/#gitea","title":"Gitea","text":"<p>Port: 3030 | Self-hosted Git service</p> <ul> <li>Git repository hosting</li> <li>Web-based interface</li> <li>Issue tracking</li> <li>Pull requests</li> <li>Wiki and code review</li> <li>Lightweight and easy to deploy</li> </ul>"},{"location":"services/#mini-qr","title":"Mini QR","text":"<p>Port: 8089 | Simple QR code generator service</p> <ul> <li>Generate QR codes for text or URLs</li> <li>Download QR codes as images</li> <li>Simple and fast interface</li> <li>No user registration required</li> </ul>"},{"location":"services/#map","title":"Map","text":"<p>Port: 3000 | Canvassing and community organizing application </p> <ul> <li>Interactive map for door-to-door canvassing</li> <li>Location and contact management</li> <li>Admin panel and QR code walk sheets</li> <li>NocoDB integration for data storage</li> <li>User authentication and access control</li> </ul>"},{"location":"services/#service-architecture","title":"Service Architecture","text":"<pre><code>\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Homepage \u2502 \u2502 Code Server \u2502 \u2502 MkDocs \u2502\n\u2502 :3010 \u2502 \u2502 :8888 \u2502 \u2502 :4000 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Static Server \u2502 \u2502 Listmonk \u2502 \u2502 n8n \u2502\n\u2502 :4001 \u2502 \u2502 :9000 \u2502 \u2502 :5678 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510 \u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 NocoDB \u2502 \u2502 PostgreSQL \u2502 \u2502 PostgreSQL \u2502\n\u2502 :8090 \u2502 \u2502 (listmonk-db) \u2502 \u2502 (root_db) \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2502 :5432 \u2502 \u2502 :5432 \u2502\n \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518 \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n\n\u250c\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510\n\u2502 Map \u2502\n\u2502 :3000 \u2502\n\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518\n</code></pre>"},{"location":"services/code-server/","title":"Code Server","text":""},{"location":"services/code-server/#overview","title":"Overview","text":"<p>Code Server provides a full Visual Studio Code experience in your web browser, allowing you to develop from any device. It runs on your server and provides access to your development environment through a web interface.</p>"},{"location":"services/code-server/#features","title":"Features","text":"<ul> <li>Full VS Code experience in the browser</li> <li>Extensions support</li> <li>Terminal access</li> <li>Git integration</li> <li>File editing and management</li> <li>Multi-language support</li> </ul>"},{"location":"services/code-server/#access","title":"Access","text":"<ul> <li>Default Port: 8888</li> <li>URL: <code>http://localhost:8888</code></li> <li>Default Workspace: <code>/home/coder/mkdocs/</code></li> </ul>"},{"location":"services/code-server/#configuration","title":"Configuration","text":""},{"location":"services/code-server/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>DOCKER_USER</code>: The user to run code-server as (default: <code>coder</code>)</li> <li><code>DEFAULT_WORKSPACE</code>: Default workspace directory</li> <li><code>USER_ID</code>: User ID for file permissions</li> <li><code>GROUP_ID</code>: Group ID for file permissions</li> </ul>"},{"location":"services/code-server/#volumes","title":"Volumes","text":"<ul> <li><code>./configs/code-server/.config</code>: VS Code configuration</li> <li><code>./configs/code-server/.local</code>: Local data</li> <li><code>./mkdocs</code>: Main workspace directory</li> </ul>"},{"location":"services/code-server/#usage","title":"Usage","text":"<ol> <li>Access Code Server at <code>http://localhost:8888</code></li> <li>Open the <code>/home/coder/mkdocs/</code> workspace</li> <li>Start editing your documentation files</li> <li>Install extensions as needed</li> <li>Use the integrated terminal for commands</li> </ol>"},{"location":"services/code-server/#useful-extensions","title":"Useful Extensions","text":"<p>Consider installing these extensions for better documentation work:</p> <ul> <li>Markdown All in One</li> <li>Material Design Icons</li> <li>GitLens</li> <li>Docker</li> <li>YAML</li> </ul>"},{"location":"services/code-server/#official-documentation","title":"Official Documentation","text":"<p>For more detailed information, visit the official Code Server documentation.</p>"},{"location":"services/gitea/","title":"Gitea","text":"<p>Self-hosted Git service for collaborative development.</p>"},{"location":"services/gitea/#overview","title":"Overview","text":"<p>Gitea is a lightweight, self-hosted Git service similar to GitHub, GitLab, and Bitbucket. It provides a web interface for managing repositories, issues, pull requests, and more.</p>"},{"location":"services/gitea/#features","title":"Features","text":"<ul> <li>Git repository hosting</li> <li>Web-based interface</li> <li>Issue tracking</li> <li>Pull requests</li> <li>Wiki and code review</li> <li>Lightweight and easy to deploy</li> </ul>"},{"location":"services/gitea/#access","title":"Access","text":"<ul> <li>Default Web Port: <code>${GITEA_WEB_PORT:-3030}</code> (default: 3030)</li> <li>Default SSH Port: <code>${GITEA_SSH_PORT:-2222}</code> (default: 2222)</li> <li>URL: <code>http://localhost:${GITEA_WEB_PORT:-3030}</code></li> <li>Default Data Directory: <code>/data/gitea</code></li> </ul>"},{"location":"services/gitea/#configuration","title":"Configuration","text":""},{"location":"services/gitea/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>GITEA__database__DB_TYPE</code>: Database type (e.g., <code>sqlite3</code>, <code>mysql</code>, <code>postgres</code>)</li> <li><code>GITEA__database__HOST</code>: Database host (default: <code>${GITEA_DB_HOST:-gitea-db:3306}</code>)</li> <li><code>GITEA__database__NAME</code>: Database name (default: <code>${GITEA_DB_NAME:-gitea}</code>)</li> <li><code>GITEA__database__USER</code>: Database user (default: <code>${GITEA_DB_USER:-gitea}</code>)</li> <li><code>GITEA__database__PASSWD</code>: Database password (from <code>.env</code>)</li> <li><code>GITEA__server__ROOT_URL</code>: Root URL (e.g., <code>${GITEA_ROOT_URL}</code>)</li> <li><code>GITEA__server__HTTP_PORT</code>: Web port (default: 3000 inside container)</li> <li><code>GITEA__server__DOMAIN</code>: Domain (e.g., <code>${GITEA_DOMAIN}</code>)</li> </ul>"},{"location":"services/gitea/#volumes","title":"Volumes","text":"<ul> <li><code>gitea_data:/data</code>: Gitea configuration and data</li> <li><code>/etc/timezone:/etc/timezone:ro</code></li> <li><code>/etc/localtime:/etc/localtime:ro</code></li> </ul>"},{"location":"services/gitea/#usage","title":"Usage","text":"<ol> <li>Access Gitea at <code>http://localhost:${GITEA_WEB_PORT:-3030}</code></li> <li>Register or log in as an admin user</li> <li>Create or import repositories</li> <li>Collaborate with your team</li> </ol>"},{"location":"services/gitea/#official-documentation","title":"Official Documentation","text":"<p>For more details, visit the official Gitea documentation.</p>"},{"location":"services/homepage/","title":"Homepage","text":"<p>Modern dashboard for accessing all your self-hosted services.</p>"},{"location":"services/homepage/#overview","title":"Overview","text":"<p>Homepage is a modern, fully static, fast, secure fully configurable application dashboard with integrations for over 100 services. It provides a beautiful and customizable interface to access all your Changemaker Lite services from a single location.</p>"},{"location":"services/homepage/#features","title":"Features","text":"<ul> <li>Service Dashboard: Central hub for all your applications</li> <li>Docker Integration: Automatic service discovery and monitoring</li> <li>Customizable Layout: Flexible grid-based layout system</li> <li>Service Widgets: Live status and metrics for services</li> <li>Quick Search: Fast navigation with built-in search</li> <li>Bookmarks: Organize frequently used links</li> <li>Dark/Light Themes: Multiple color schemes available</li> <li>Responsive Design: Works on desktop and mobile devices</li> </ul>"},{"location":"services/homepage/#access","title":"Access","text":"<ul> <li>Default Port: 3010</li> <li>URL: <code>http://localhost:3010</code></li> <li>Configuration: YAML-based configuration files</li> </ul>"},{"location":"services/homepage/#configuration","title":"Configuration","text":""},{"location":"services/homepage/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>HOMEPAGE_PORT</code>: External port mapping (default: 3010)</li> <li><code>PUID</code>: User ID for file permissions (default: 1000)</li> <li><code>PGID</code>: Group ID for file permissions (default: 1000)</li> <li><code>TZ</code>: Timezone setting (default: Etc/UTC)</li> <li><code>HOMEPAGE_ALLOWED_HOSTS</code>: Allowed hosts for the dashboard</li> </ul>"},{"location":"services/homepage/#configuration-files","title":"Configuration Files","text":"<p>Homepage uses YAML configuration files located in <code>./configs/homepage/</code>:</p> <ul> <li><code>settings.yaml</code>: Global settings and theme configuration</li> <li><code>services.yaml</code>: Service definitions and widgets</li> <li><code>bookmarks.yaml</code>: Bookmark categories and links</li> <li><code>widgets.yaml</code>: Dashboard widgets configuration</li> <li><code>docker.yaml</code>: Docker integration settings</li> </ul>"},{"location":"services/homepage/#volumes","title":"Volumes","text":"<ul> <li><code>./configs/homepage:/app/config</code>: Configuration files</li> <li><code>./assets/icons:/app/public/icons</code>: Custom service icons</li> <li><code>./assets/images:/app/public/images</code>: Background images and assets</li> <li><code>/var/run/docker.sock:/var/run/docker.sock</code>: Docker socket for container monitoring</li> </ul>"},{"location":"services/homepage/#changemaker-lite-services","title":"Changemaker Lite Services","text":"<p>Homepage is pre-configured with all Changemaker Lite services:</p>"},{"location":"services/homepage/#essential-tools","title":"Essential Tools","text":"<ul> <li>Code Server (Port 8888): VS Code in the browser</li> <li>Listmonk (Port 9000): Newsletter & mailing list manager</li> <li>NocoDB (Port 8090): No-code database platform</li> </ul>"},{"location":"services/homepage/#content-documentation","title":"Content & Documentation","text":"<ul> <li>MkDocs (Port 4000): Live documentation server</li> <li>Static Site (Port 4001): Built documentation hosting</li> </ul>"},{"location":"services/homepage/#automation-data","title":"Automation & Data","text":"<ul> <li>n8n (Port 5678): Workflow automation platform</li> <li>PostgreSQL (Port 5432): Database backends</li> </ul>"},{"location":"services/homepage/#customization","title":"Customization","text":""},{"location":"services/homepage/#adding-custom-services","title":"Adding Custom Services","text":"<p>Edit <code>configs/homepage/services.yaml</code> to add new services:</p> <pre><code>- Custom Category:\n - My Service:\n href: http://localhost:8080\n description: Custom service description\n icon: mdi-application\n widget:\n type: ping\n url: http://localhost:8080\n</code></pre>"},{"location":"services/homepage/#custom-icons","title":"Custom Icons","text":"<p>Add custom icons to <code>./assets/icons/</code> directory and reference them in services.yaml:</p> <pre><code>icon: /icons/my-custom-icon.png\n</code></pre>"},{"location":"services/homepage/#themes-and-styling","title":"Themes and Styling","text":"<p>Modify <code>configs/homepage/settings.yaml</code> to customize appearance:</p> <pre><code>theme: dark # or light\ncolor: purple # slate, gray, zinc, neutral, stone, red, orange, amber, yellow, lime, green, emerald, teal, cyan, sky, blue, indigo, violet, purple, fuchsia, pink, rose\n</code></pre>"},{"location":"services/homepage/#widgets","title":"Widgets","text":"<p>Enable live monitoring widgets in <code>configs/homepage/services.yaml</code>:</p> <pre><code>- Service Name:\n widget:\n type: docker\n container: container-name\n server: my-docker\n</code></pre>"},{"location":"services/homepage/#service-monitoring","title":"Service Monitoring","text":"<p>Homepage can display real-time status information for your services:</p> <ul> <li>Docker Integration: Container status and resource usage</li> <li>HTTP Ping: Service availability monitoring</li> <li>Custom APIs: Integration with service-specific APIs</li> </ul>"},{"location":"services/homepage/#docker-integration","title":"Docker Integration","text":"<p>Homepage monitors Docker containers automatically when configured:</p> <ol> <li>Ensure Docker socket is mounted (<code>/var/run/docker.sock</code>)</li> <li>Configure container mappings in <code>docker.yaml</code></li> <li>Add widget configurations to <code>services.yaml</code></li> </ol>"},{"location":"services/homepage/#security-considerations","title":"Security Considerations","text":"<ul> <li>Homepage runs with limited privileges</li> <li>Configuration files should have appropriate permissions</li> <li>Consider network isolation for production deployments</li> <li>Use HTTPS for external access</li> <li>Regularly update the Homepage image</li> </ul>"},{"location":"services/homepage/#troubleshooting","title":"Troubleshooting","text":""},{"location":"services/homepage/#common-issues","title":"Common Issues","text":"<p>Configuration not loading: Check YAML syntax in configuration files</p> <pre><code>docker logs homepage-changemaker\n</code></pre> <p>Icons not displaying: Verify icon paths and file permissions</p> <pre><code>ls -la ./assets/icons/\n</code></pre> <p>Services not reachable: Verify network connectivity between containers</p> <pre><code>docker exec homepage-changemaker ping service-name\n</code></pre> <p>Widget data not updating: Check Docker socket permissions and container access</p> <pre><code>docker exec homepage-changemaker ls -la /var/run/docker.sock\n</code></pre>"},{"location":"services/homepage/#configuration-examples","title":"Configuration Examples","text":""},{"location":"services/homepage/#basic-service-widget","title":"Basic Service Widget","text":"<pre><code>- Code Server:\n href: http://localhost:8888\n description: VS Code in the browser\n icon: code-server\n widget:\n type: docker\n container: code-server-changemaker\n</code></pre>"},{"location":"services/homepage/#custom-dashboard-layout","title":"Custom Dashboard Layout","text":"<pre><code># settings.yaml\nlayout:\n style: columns\n columns: 3\n\n# Responsive breakpoints\nresponsive:\n mobile: 1\n tablet: 2\n desktop: 3\n</code></pre>"},{"location":"services/homepage/#official-documentation","title":"Official Documentation","text":"<p>For comprehensive configuration guides and advanced features:</p> <ul> <li>Homepage Documentation</li> <li>GitHub Repository</li> <li>Configuration Examples</li> <li>Widget Integrations</li> </ul>"},{"location":"services/listmonk/","title":"Listmonk","text":"<p>Self-hosted newsletter and mailing list manager.</p>"},{"location":"services/listmonk/#overview","title":"Overview","text":"<p>Listmonk is a modern, feature-rich newsletter and mailing list manager designed for high performance and easy management. It provides a complete solution for email campaigns, subscriber management, and analytics.</p>"},{"location":"services/listmonk/#features","title":"Features","text":"<ul> <li>Newsletter and email campaign management</li> <li>Subscriber list management</li> <li>Template system with HTML/markdown support</li> <li>Campaign analytics and tracking</li> <li>API for integration</li> <li>Multi-list support</li> <li>Bounce handling</li> <li>Privacy-focused design</li> </ul>"},{"location":"services/listmonk/#access","title":"Access","text":"<ul> <li>Default Port: 9000</li> <li>URL: <code>http://localhost:9000</code></li> <li>Admin User: Set via <code>LISTMONK_ADMIN_USER</code> environment variable</li> <li>Admin Password: Set via <code>LISTMONK_ADMIN_PASSWORD</code> environment variable</li> </ul>"},{"location":"services/listmonk/#configuration","title":"Configuration","text":""},{"location":"services/listmonk/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>LISTMONK_ADMIN_USER</code>: Admin username</li> <li><code>LISTMONK_ADMIN_PASSWORD</code>: Admin password</li> <li><code>POSTGRES_USER</code>: Database username</li> <li><code>POSTGRES_PASSWORD</code>: Database password</li> <li><code>POSTGRES_DB</code>: Database name</li> </ul>"},{"location":"services/listmonk/#database","title":"Database","text":"<p>Listmonk uses PostgreSQL as its backend database. The database is automatically configured through the docker-compose setup.</p>"},{"location":"services/listmonk/#uploads","title":"Uploads","text":"<ul> <li>Upload directory: <code>./assets/uploads</code></li> <li>Used for media files, templates, and attachments</li> </ul>"},{"location":"services/listmonk/#getting-started","title":"Getting Started","text":"<ol> <li>Access Listmonk at <code>http://localhost:9000</code></li> <li>Log in with your admin credentials</li> <li>Set up your first mailing list</li> <li>Configure SMTP settings for sending emails</li> <li>Import subscribers or create subscription forms</li> <li>Create your first campaign</li> </ol>"},{"location":"services/listmonk/#important-notes","title":"Important Notes","text":"<ul> <li>Configure SMTP settings before sending emails</li> <li>Set up proper domain authentication (SPF, DKIM) for better deliverability</li> <li>Regularly backup your subscriber data and campaigns</li> <li>Monitor bounce rates and maintain list hygiene</li> </ul>"},{"location":"services/listmonk/#official-documentation","title":"Official Documentation","text":"<p>For comprehensive guides and API documentation, visit: - Listmonk Documentation - GitHub Repository</p>"},{"location":"services/map/","title":"Map","text":"<p>Interactive map service for geospatial data visualization, powered by NocoDB and Leaflet.js.</p>"},{"location":"services/map/#overview","title":"Overview","text":"<p>The Map service provides an interactive web-based map for displaying, searching, and analyzing geospatial data from a NocoDB backend. It supports real-time geolocation, adding new locations, and is optimized for both desktop and mobile use.</p>"},{"location":"services/map/#features","title":"Features","text":"<ul> <li>Interactive map visualization with OpenStreetMap</li> <li>Real-time geolocation support</li> <li>Add new locations directly from the map</li> <li>Auto-refresh every 30 seconds</li> <li>Responsive design for mobile devices</li> <li>Secure API proxy to protect credentials</li> <li>Docker containerization for easy deployment</li> </ul>"},{"location":"services/map/#access","title":"Access","text":"<ul> <li>Default Port: <code>${MAP_PORT:-3000}</code> (default: 3000)</li> <li>URL: <code>http://localhost:${MAP_PORT:-3000}</code></li> <li>Default Workspace: <code>/app/public/</code></li> </ul>"},{"location":"services/map/#configuration","title":"Configuration","text":"<p>All configuration is done via environment variables:</p> Variable Description Default <code>NOCODB_API_URL</code> NocoDB API base URL Required <code>NOCODB_API_TOKEN</code> API authentication token Required <code>NOCODB_VIEW_URL</code> Full NocoDB view URL Required <code>PORT</code> Server port 3000 <code>DEFAULT_LAT</code> Default map latitude 53.5461 <code>DEFAULT_LNG</code> Default map longitude -113.4938 <code>DEFAULT_ZOOM</code> Default map zoom level 11"},{"location":"services/map/#volumes","title":"Volumes","text":"<ul> <li><code>./map/app/public</code>: Map public assets</li> </ul>"},{"location":"services/map/#usage","title":"Usage","text":"<ol> <li>Access the map at <code>http://localhost:${MAP_PORT:-3000}</code></li> <li>Search for locations or addresses</li> <li>Add or view custom markers</li> <li>Analyze geospatial data as needed</li> </ol>"},{"location":"services/map/#nocodb-table-setup","title":"NocoDB Table Setup","text":""},{"location":"services/map/#required-columns","title":"Required Columns","text":"<ul> <li><code>geodata</code> (Text): Format \"latitude;longitude\" </li> <li><code>latitude</code> (Decimal): Precision 10, Scale 8</li> <li><code>longitude</code> (Decimal): Precision 11, Scale 8</li> </ul>"},{"location":"services/map/#form-fields-as-seen-in-the-interface","title":"Form Fields (as seen in the interface)","text":"<ul> <li><code>First Name</code> (Text): Person's first name</li> <li><code>Last Name</code> (Text): Person's last name </li> <li><code>Email</code> (Email): Contact email address</li> <li><code>Unit Number</code> (Text): Apartment/unit number</li> <li><code>Support Level</code> (Single Select): </li> <li>1 - Strong Support (Green)</li> <li>2 - Moderate Support (Yellow) </li> <li>3 - Low Support (Orange)</li> <li>4 - No Support (Red)</li> <li><code>Address</code> (Text): Full street address</li> <li><code>Sign</code> (Checkbox): Has campaign sign (true/false)</li> <li><code>Sign Size</code> (Single Select): Small, Medium, Large</li> <li><code>Geo-Location</code> (Text): Formatted as \"latitude;longitude\"</li> </ul>"},{"location":"services/map/#api-endpoints","title":"API Endpoints","text":"<ul> <li><code>GET /api/locations</code> - Fetch all locations</li> <li><code>POST /api/locations</code> - Create new location</li> <li><code>GET /api/locations/:id</code> - Get single location</li> <li><code>PUT /api/locations/:id</code> - Update location</li> <li><code>DELETE /api/locations/:id</code> - Delete location</li> <li><code>GET /health</code> - Health check</li> </ul>"},{"location":"services/map/#security-considerations","title":"Security Considerations","text":"<ul> <li>API tokens are kept server-side only</li> <li>CORS is configured for security</li> <li>Rate limiting prevents abuse</li> <li>Input validation on all endpoints</li> <li>Helmet.js for security headers</li> </ul>"},{"location":"services/map/#troubleshooting","title":"Troubleshooting","text":"<ul> <li>Ensure NocoDB table has required columns and valid coordinates</li> <li>Check API token permissions and network connectivity</li> </ul>"},{"location":"services/mini-qr/","title":"Mini QR","text":"<p>Simple QR code generator service.</p>"},{"location":"services/mini-qr/#overview","title":"Overview","text":"<p>Mini QR is a lightweight service for generating QR codes for URLs, text, or other data. It provides a web interface for quick QR code creation and download.</p>"},{"location":"services/mini-qr/#features","title":"Features","text":"<ul> <li>Generate QR codes for text or URLs</li> <li>Download QR codes as images</li> <li>Simple and fast interface</li> <li>No user registration required</li> </ul>"},{"location":"services/mini-qr/#access","title":"Access","text":"<ul> <li>Default Port: <code>${MINI_QR_PORT:-8089}</code> (default: 8089)</li> <li>URL: <code>http://localhost:${MINI_QR_PORT:-8089}</code></li> </ul>"},{"location":"services/mini-qr/#configuration","title":"Configuration","text":""},{"location":"services/mini-qr/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>QR_DEFAULT_SIZE</code>: Default size of generated QR codes</li> <li><code>QR_IMAGE_FORMAT</code>: Image format (e.g., <code>png</code>, <code>svg</code>)</li> </ul>"},{"location":"services/mini-qr/#volumes","title":"Volumes","text":"<ul> <li><code>./configs/mini-qr</code>: QR code service configuration</li> </ul>"},{"location":"services/mini-qr/#usage","title":"Usage","text":"<ol> <li>Access Mini QR at <code>http://localhost:${MINI_QR_PORT:-8089}</code></li> <li>Enter the text or URL to encode</li> <li>Download or share the generated QR code</li> </ol>"},{"location":"services/mkdocs/","title":"MkDocs Material","text":"<p>Modern documentation site generator with live preview. </p> <p>Looking for more info on BNKops code-server integration? </p> <p>\u2192 Code Server Configuration</p>"},{"location":"services/mkdocs/#overview","title":"Overview","text":"<p>MkDocs Material is a powerful documentation framework built on top of MkDocs, providing a beautiful Material Design theme and advanced features for creating professional documentation sites.</p>"},{"location":"services/mkdocs/#features","title":"Features","text":"<ul> <li>Material Design theme</li> <li>Live preview during development</li> <li>Search functionality</li> <li>Navigation and organization</li> <li>Code syntax highlighting</li> <li>Mathematical expressions support</li> <li>Responsive design</li> <li>Customizable themes and colors</li> </ul>"},{"location":"services/mkdocs/#access","title":"Access","text":"<ul> <li>Development Port: 4000</li> <li>Development URL: <code>http://localhost:4000</code></li> <li>Live Reload: Automatically refreshes on file changes</li> </ul>"},{"location":"services/mkdocs/#configuration","title":"Configuration","text":""},{"location":"services/mkdocs/#main-configuration","title":"Main Configuration","text":"<p>Configuration is managed through <code>mkdocs.yml</code> in the project root.</p>"},{"location":"services/mkdocs/#volumes","title":"Volumes","text":"<ul> <li><code>./mkdocs</code>: Documentation source files</li> <li><code>./assets/images</code>: Shared images directory</li> </ul>"},{"location":"services/mkdocs/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>SITE_URL</code>: Base domain for the site</li> <li><code>USER_ID</code>: User ID for file permissions</li> <li><code>GROUP_ID</code>: Group ID for file permissions</li> </ul>"},{"location":"services/mkdocs/#directory-structure","title":"Directory Structure","text":"<pre><code>mkdocs/\n\u251c\u2500\u2500 mkdocs.yml # Configuration file\n\u251c\u2500\u2500 docs/ # Documentation source\n\u2502 \u251c\u2500\u2500 index.md # Homepage\n\u2502 \u251c\u2500\u2500 services/ # Service documentation\n\u2502 \u251c\u2500\u2500 blog/ # Blog posts\n\u2502 \u2514\u2500\u2500 overrides/ # Template overrides\n\u2514\u2500\u2500 site/ # Built static site\n</code></pre>"},{"location":"services/mkdocs/#writing-documentation","title":"Writing Documentation","text":""},{"location":"services/mkdocs/#markdown-basics","title":"Markdown Basics","text":"<ul> <li>Use standard Markdown syntax</li> <li>Support for tables, code blocks, and links</li> <li>Mathematical expressions with MathJax</li> <li>Admonitions for notes and warnings</li> </ul>"},{"location":"services/mkdocs/#example-page","title":"Example Page","text":"<pre><code># Page Title\n\nThis is a sample documentation page.\n\n## Section\n\nContent goes here with **bold** and *italic* text.\n\n### Code Example\n\n```python\ndef hello_world():\n print(\"Hello, World!\")\n</code></pre> <p>Note</p> <p>This is an informational note.</p> <pre><code>## Building and Deployment\n\n### Development\n\nThe development server runs automatically with live reload.\n\n### Building Static Site\n\n```bash\ndocker exec mkdocs-changemaker mkdocs build\n</code></pre> <p>The built site will be available in the <code>mkdocs/site/</code> directory.</p>"},{"location":"services/mkdocs/#customization","title":"Customization","text":""},{"location":"services/mkdocs/#themes-and-colors","title":"Themes and Colors","text":"<p>Customize appearance in <code>mkdocs.yml</code>:</p> <pre><code>theme:\n name: material\n palette:\n primary: blue\n accent: indigo\n</code></pre>"},{"location":"services/mkdocs/#custom-css","title":"Custom CSS","text":"<p>Add custom styles in <code>docs/stylesheets/extra.css</code>.</p>"},{"location":"services/mkdocs/#official-documentation","title":"Official Documentation","text":"<p>For comprehensive MkDocs Material documentation: - MkDocs Material - MkDocs Documentation - Markdown Guide</p>"},{"location":"services/n8n/","title":"n8n","text":"<p>Workflow automation tool for connecting services and automating tasks.</p>"},{"location":"services/n8n/#overview","title":"Overview","text":"<p>n8n is a powerful workflow automation tool that allows you to connect various apps and services together. It provides a visual interface for creating automated workflows, making it easy to integrate different systems and automate repetitive tasks.</p>"},{"location":"services/n8n/#features","title":"Features","text":"<ul> <li>Visual workflow editor</li> <li>400+ integrations</li> <li>Custom code execution (JavaScript/Python)</li> <li>Webhook support</li> <li>Scheduled workflows</li> <li>Error handling and retries</li> <li>User management</li> <li>API access</li> <li>Self-hosted and privacy-focused</li> </ul>"},{"location":"services/n8n/#access","title":"Access","text":"<ul> <li>Default Port: 5678</li> <li>URL: <code>http://localhost:5678</code></li> <li>Default User Email: Set via <code>N8N_DEFAULT_USER_EMAIL</code></li> <li>Default User Password: Set via <code>N8N_DEFAULT_USER_PASSWORD</code></li> </ul>"},{"location":"services/n8n/#configuration","title":"Configuration","text":""},{"location":"services/n8n/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>N8N_HOST</code>: Hostname for n8n (default: <code>n8n.${DOMAIN}</code>)</li> <li><code>N8N_PORT</code>: Internal port (5678)</li> <li><code>N8N_PROTOCOL</code>: Protocol for webhooks (https)</li> <li><code>NODE_ENV</code>: Environment (production)</li> <li><code>WEBHOOK_URL</code>: Base URL for webhooks</li> <li><code>GENERIC_TIMEZONE</code>: Timezone setting</li> <li><code>N8N_ENCRYPTION_KEY</code>: Encryption key for credentials</li> <li><code>N8N_USER_MANAGEMENT_DISABLED</code>: Enable/disable user management</li> <li><code>N8N_DEFAULT_USER_EMAIL</code>: Default admin email</li> <li><code>N8N_DEFAULT_USER_PASSWORD</code>: Default admin password</li> </ul>"},{"location":"services/n8n/#volumes","title":"Volumes","text":"<ul> <li><code>n8n_data</code>: Persistent data storage</li> <li><code>./local-files</code>: Local file access for workflows</li> </ul>"},{"location":"services/n8n/#getting-started","title":"Getting Started","text":"<ol> <li>Access n8n at <code>http://localhost:5678</code></li> <li>Log in with your admin credentials</li> <li>Create your first workflow</li> <li>Add nodes for different services</li> <li>Configure connections between nodes</li> <li>Test and activate your workflow</li> </ol>"},{"location":"services/n8n/#common-use-cases","title":"Common Use Cases","text":""},{"location":"services/n8n/#documentation-automation","title":"Documentation Automation","text":"<ul> <li>Auto-generate documentation from code comments</li> <li>Sync documentation between different platforms</li> <li>Notify team when documentation is updated</li> </ul>"},{"location":"services/n8n/#email-campaign-integration","title":"Email Campaign Integration","text":"<ul> <li>Connect Listmonk with external data sources</li> <li>Automate subscriber management</li> <li>Trigger campaigns based on events</li> </ul>"},{"location":"services/n8n/#database-management-with-nocodb","title":"Database Management with NocoDB","text":"<ul> <li>Sync data between NocoDB and external APIs</li> <li>Automate data entry and validation</li> <li>Create backup workflows for database content</li> <li>Generate reports from NocoDB data</li> </ul>"},{"location":"services/n8n/#development-workflows","title":"Development Workflows","text":"<ul> <li>Auto-deploy documentation on git push</li> <li>Sync code changes with documentation</li> <li>Backup automation</li> </ul>"},{"location":"services/n8n/#data-processing","title":"Data Processing","text":"<ul> <li>Process CSV files and import to databases</li> <li>Transform data between different formats</li> <li>Schedule regular data updates</li> </ul>"},{"location":"services/n8n/#example-workflows","title":"Example Workflows","text":""},{"location":"services/n8n/#simple-webhook-to-email","title":"Simple Webhook to Email","text":"<pre><code>Webhook \u2192 Email\n</code></pre>"},{"location":"services/n8n/#scheduled-documentation-backup","title":"Scheduled Documentation Backup","text":"<pre><code>Schedule \u2192 Read Files \u2192 Compress \u2192 Upload to Storage\n</code></pre>"},{"location":"services/n8n/#git-integration","title":"Git Integration","text":"<pre><code>Git Webhook \u2192 Process Changes \u2192 Update Documentation \u2192 Notify Team\n</code></pre>"},{"location":"services/n8n/#security-considerations","title":"Security Considerations","text":"<ul> <li>Use strong encryption keys</li> <li>Secure webhook URLs</li> <li>Regularly update credentials</li> <li>Monitor workflow executions</li> <li>Implement proper error handling</li> </ul>"},{"location":"services/n8n/#integration-with-other-services","title":"Integration with Other Services","text":"<p>n8n can integrate with all services in your Changemaker Lite setup:</p> <ul> <li>Listmonk: Manage subscribers and campaigns</li> <li>PostgreSQL: Read/write database operations</li> <li>Code Server: File operations and git integration</li> <li>MkDocs: Documentation generation and updates</li> </ul>"},{"location":"services/n8n/#troubleshooting","title":"Troubleshooting","text":""},{"location":"services/n8n/#common-issues","title":"Common Issues","text":"<ul> <li>Workflow Execution Errors: Check node configurations and credentials</li> <li>Webhook Issues: Verify URLs and authentication</li> <li>Connection Problems: Check network connectivity between services</li> </ul>"},{"location":"services/n8n/#debugging","title":"Debugging","text":"<pre><code># Check container logs\ndocker logs n8n-changemaker\n\n# Access container shell\ndocker exec -it n8n-changemaker sh\n\n# Check workflow executions in the UI\n# Visit http://localhost:5678 \u2192 Executions\n</code></pre>"},{"location":"services/n8n/#official-documentation","title":"Official Documentation","text":"<p>For comprehensive n8n documentation:</p> <ul> <li>n8n Documentation</li> <li>Community Workflows</li> <li>Node Reference</li> <li>GitHub Repository</li> </ul>"},{"location":"services/nocodb/","title":"NocoDB","text":"<p>No-code database platform that turns any database into a smart spreadsheet.</p>"},{"location":"services/nocodb/#overview","title":"Overview","text":"<p>NocoDB is an open-source no-code platform that transforms any database into a smart spreadsheet interface. It provides a user-friendly way to manage data, create forms, build APIs, and collaborate on database operations without requiring extensive technical knowledge.</p>"},{"location":"services/nocodb/#features","title":"Features","text":"<ul> <li>Smart Spreadsheet Interface: Transform databases into intuitive spreadsheets</li> <li>Form Builder: Create custom forms for data entry</li> <li>API Generation: Auto-generated REST APIs for all tables</li> <li>Collaboration: Real-time collaboration with team members</li> <li>Access Control: Role-based permissions and sharing</li> <li>Data Visualization: Charts and dashboard creation</li> <li>Webhooks: Integration with external services</li> <li>Import/Export: Support for CSV, Excel, and other formats</li> <li>Multi-Database Support: Works with PostgreSQL, MySQL, SQLite, and more</li> </ul>"},{"location":"services/nocodb/#access","title":"Access","text":"<ul> <li>Default Port: 8090</li> <li>URL: <code>http://localhost:8090</code></li> <li>Database: PostgreSQL (dedicated <code>root_db</code> instance)</li> </ul>"},{"location":"services/nocodb/#configuration","title":"Configuration","text":""},{"location":"services/nocodb/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>NOCODB_PORT</code>: External port mapping (default: 8090)</li> <li><code>NC_DB</code>: Database connection string for PostgreSQL backend</li> </ul>"},{"location":"services/nocodb/#database-backend","title":"Database Backend","text":"<p>NocoDB uses a dedicated PostgreSQL instance (<code>root_db</code>) with the following configuration:</p> <ul> <li>Database Name: <code>root_db</code></li> <li>Username: <code>postgres</code></li> <li>Password: <code>password</code></li> <li>Host: <code>root_db</code> (internal container name)</li> </ul>"},{"location":"services/nocodb/#volumes","title":"Volumes","text":"<ul> <li><code>nc_data</code>: Application data and configuration storage</li> <li><code>db_data</code>: PostgreSQL database files</li> </ul>"},{"location":"services/nocodb/#getting-started","title":"Getting Started","text":"<ol> <li>Access NocoDB: Navigate to <code>http://localhost:8090</code></li> <li>Initial Setup: Complete the onboarding process</li> <li>Create Project: Start with a new project or connect existing databases</li> <li>Add Tables: Import data or create new tables</li> <li>Configure Views: Set up different views (Grid, Form, Gallery, etc.)</li> <li>Set Permissions: Configure user access and sharing settings</li> </ol>"},{"location":"services/nocodb/#common-use-cases","title":"Common Use Cases","text":""},{"location":"services/nocodb/#content-management","title":"Content Management","text":"<ul> <li>Create content databases for blogs and websites</li> <li>Manage product catalogs and inventories</li> <li>Track customer information and interactions</li> </ul>"},{"location":"services/nocodb/#project-management","title":"Project Management","text":"<ul> <li>Task and project tracking systems</li> <li>Team collaboration workspaces</li> <li>Resource and timeline management</li> </ul>"},{"location":"services/nocodb/#data-collection","title":"Data Collection","text":"<ul> <li>Custom forms for surveys and feedback</li> <li>Event registration and management</li> <li>Lead capture and CRM systems</li> </ul>"},{"location":"services/nocodb/#integration-with-other-services","title":"Integration with Other Services","text":"<p>NocoDB can integrate well with other Changemaker Lite services:</p> <ul> <li>n8n Integration: Use NocoDB as a data source/destination in automation workflows</li> <li>Listmonk Integration: Manage subscriber lists and campaign data</li> <li>Documentation: Store and manage documentation metadata</li> </ul>"},{"location":"services/nocodb/#api-usage","title":"API Usage","text":"<p>NocoDB automatically generates REST APIs for all your tables:</p> <pre><code># Get all records from a table\nGET http://localhost:8090/api/v1/db/data/v1/{project}/table/{table}\n\n# Create a new record\nPOST http://localhost:8090/api/v1/db/data/v1/{project}/table/{table}\n\n# Update a record\nPATCH http://localhost:8090/api/v1/db/data/v1/{project}/table/{table}/{id}\n</code></pre>"},{"location":"services/nocodb/#backup-and-data-management","title":"Backup and Data Management","text":""},{"location":"services/nocodb/#database-backup","title":"Database Backup","text":"<p>Since NocoDB uses PostgreSQL, you can backup the database:</p> <pre><code># Backup NocoDB database\ndocker exec root_db pg_dump -U postgres root_db > nocodb_backup.sql\n\n# Restore from backup\ndocker exec -i root_db psql -U postgres root_db < nocodb_backup.sql\n</code></pre>"},{"location":"services/nocodb/#application-data","title":"Application Data","text":"<p>Application settings and metadata are stored in the <code>nc_data</code> volume.</p>"},{"location":"services/nocodb/#security-considerations","title":"Security Considerations","text":"<ul> <li>Change default database credentials in production</li> <li>Configure proper access controls within NocoDB</li> <li>Use HTTPS for production deployments</li> <li>Regularly backup both database and application data</li> <li>Monitor access logs and user activities</li> </ul>"},{"location":"services/nocodb/#performance-tips","title":"Performance Tips","text":"<ul> <li>Regular database maintenance and optimization</li> <li>Monitor memory usage for large datasets</li> <li>Use appropriate indexing for frequently queried fields</li> <li>Consider database connection pooling for high-traffic scenarios</li> </ul>"},{"location":"services/nocodb/#troubleshooting","title":"Troubleshooting","text":""},{"location":"services/nocodb/#common-issues","title":"Common Issues","text":"<p>Service won't start: Check if the PostgreSQL database is healthy</p> <pre><code>docker logs root_db\n</code></pre> <p>Database connection errors: Verify database credentials and network connectivity</p> <pre><code>docker exec nocodb nc_data nc\n</code></pre> <p>Performance issues: Monitor resource usage and optimize queries</p> <pre><code>docker stats nocodb root_db\n</code></pre>"},{"location":"services/nocodb/#official-documentation","title":"Official Documentation","text":"<p>For comprehensive guides and advanced features:</p> <ul> <li>NocoDB Documentation</li> <li>GitHub Repository</li> <li>Community Forum</li> </ul>"},{"location":"services/postgresql/","title":"PostgreSQL Database","text":"<p>Reliable database backend for applications.</p>"},{"location":"services/postgresql/#overview","title":"Overview","text":"<p>PostgreSQL is a powerful, open-source relational database system. In Changemaker Lite, it serves as the backend database for Listmonk and can be used by other applications requiring persistent data storage.</p>"},{"location":"services/postgresql/#features","title":"Features","text":"<ul> <li>ACID compliance</li> <li>Advanced SQL features</li> <li>JSON/JSONB support</li> <li>Full-text search</li> <li>Extensibility</li> <li>High performance</li> <li>Reliability and data integrity</li> </ul>"},{"location":"services/postgresql/#access","title":"Access","text":"<ul> <li>Default Port: 5432</li> <li>Host: <code>listmonk-db</code> (internal container name)</li> <li>Database: Set via <code>POSTGRES_DB</code> environment variable</li> <li>Username: Set via <code>POSTGRES_USER</code> environment variable</li> <li>Password: Set via <code>POSTGRES_PASSWORD</code> environment variable</li> </ul>"},{"location":"services/postgresql/#configuration","title":"Configuration","text":""},{"location":"services/postgresql/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>POSTGRES_USER</code>: Database username</li> <li><code>POSTGRES_PASSWORD</code>: Database password </li> <li><code>POSTGRES_DB</code>: Database name</li> </ul>"},{"location":"services/postgresql/#health-checks","title":"Health Checks","text":"<p>The PostgreSQL container includes health checks to ensure the database is ready before dependent services start.</p>"},{"location":"services/postgresql/#data-persistence","title":"Data Persistence","text":"<p>Database data is stored in a Docker volume (<code>listmonk-data</code>) to ensure persistence across container restarts.</p>"},{"location":"services/postgresql/#connecting-to-the-database","title":"Connecting to the Database","text":""},{"location":"services/postgresql/#from-host-machine","title":"From Host Machine","text":"<p>You can connect to PostgreSQL from your host machine using:</p> <pre><code>psql -h localhost -p 5432 -U [username] -d [database]\n</code></pre>"},{"location":"services/postgresql/#from-other-containers","title":"From Other Containers","text":"<p>Other containers can connect using the internal hostname <code>listmonk-db</code> on port 5432.</p>"},{"location":"services/postgresql/#backup-and-restore","title":"Backup and Restore","text":""},{"location":"services/postgresql/#backup","title":"Backup","text":"<pre><code>docker exec listmonk-db pg_dump -U [username] [database] > backup.sql\n</code></pre>"},{"location":"services/postgresql/#restore","title":"Restore","text":"<pre><code>docker exec -i listmonk-db psql -U [username] [database] < backup.sql\n</code></pre>"},{"location":"services/postgresql/#monitoring","title":"Monitoring","text":"<p>Monitor database health and performance through: - Container logs: <code>docker logs listmonk-db</code> - Database metrics and queries - Connection monitoring</p>"},{"location":"services/postgresql/#security-considerations","title":"Security Considerations","text":"<ul> <li>Use strong passwords</li> <li>Regularly update PostgreSQL version</li> <li>Monitor access logs</li> <li>Implement regular backups</li> <li>Consider network isolation</li> </ul>"},{"location":"services/postgresql/#official-documentation","title":"Official Documentation","text":"<p>For comprehensive PostgreSQL documentation: - PostgreSQL Documentation - Docker PostgreSQL Image</p>"},{"location":"services/static-server/","title":"Static Site Server","text":"<p>Nginx-powered static site server for hosting built documentation and websites.</p>"},{"location":"services/static-server/#overview","title":"Overview","text":"<p>The Static Site Server uses Nginx to serve your built documentation and static websites. It's configured to serve the built MkDocs site and other static content with high performance and reliability.</p>"},{"location":"services/static-server/#features","title":"Features","text":"<ul> <li>High-performance static file serving</li> <li>Automatic index file handling</li> <li>Gzip compression</li> <li>Caching headers</li> <li>Security headers</li> <li>Custom error pages</li> <li>URL rewriting support</li> </ul>"},{"location":"services/static-server/#access","title":"Access","text":"<ul> <li>Default Port: 4001</li> <li>URL: <code>http://localhost:4001</code></li> <li>Document Root: <code>/config/www</code> (mounted from <code>./mkdocs/site</code>)</li> </ul>"},{"location":"services/static-server/#configuration","title":"Configuration","text":""},{"location":"services/static-server/#environment-variables","title":"Environment Variables","text":"<ul> <li><code>PUID</code>: User ID for file permissions (default: 1000)</li> <li><code>PGID</code>: Group ID for file permissions (default: 1000)</li> <li><code>TZ</code>: Timezone setting (default: Etc/UTC)</li> </ul>"},{"location":"services/static-server/#volumes","title":"Volumes","text":"<ul> <li><code>./mkdocs/site:/config/www</code>: Static site files</li> <li>Built MkDocs site is automatically served</li> </ul>"},{"location":"services/static-server/#usage","title":"Usage","text":"<ol> <li>Build your MkDocs site: <code>docker exec mkdocs-changemaker mkdocs build</code></li> <li>The built site is automatically available at <code>http://localhost:4001</code></li> <li>Any files in <code>./mkdocs/site/</code> will be served statically</li> </ol>"},{"location":"services/static-server/#file-structure","title":"File Structure","text":"<pre><code>mkdocs/site/ # Served at /\n\u251c\u2500\u2500 index.html # Homepage\n\u251c\u2500\u2500 assets/ # CSS, JS, images\n\u251c\u2500\u2500 services/ # Service documentation\n\u2514\u2500\u2500 search/ # Search functionality\n</code></pre>"},{"location":"services/static-server/#performance-features","title":"Performance Features","text":"<ul> <li>Gzip Compression: Automatic compression for text files</li> <li>Browser Caching: Optimized cache headers</li> <li>Fast Static Serving: Nginx optimized for static content</li> <li>Security Headers: Basic security header configuration</li> </ul>"},{"location":"services/static-server/#custom-configuration","title":"Custom Configuration","text":"<p>For advanced Nginx configuration, you can: 1. Create custom Nginx config files 2. Mount them as volumes 3. Restart the container</p>"},{"location":"services/static-server/#monitoring","title":"Monitoring","text":"<p>Monitor the static site server through: - Container logs: <code>docker logs mkdocs-site-server-changemaker</code> - Access logs for traffic analysis - Performance metrics</p>"},{"location":"services/static-server/#troubleshooting","title":"Troubleshooting","text":""},{"location":"services/static-server/#common-issues","title":"Common Issues","text":"<ul> <li>404 Errors: Ensure MkDocs site is built and files exist in <code>./mkdocs/site/</code></li> <li>Permission Issues: Check <code>PUID</code> and <code>PGID</code> settings</li> <li>File Not Found: Verify file paths and case sensitivity</li> </ul>"},{"location":"services/static-server/#debugging","title":"Debugging","text":"<pre><code># Check container logs\ndocker logs mkdocs-site-server-changemaker\n\n# Verify files are present\ndocker exec mkdocs-site-server-changemaker ls -la /config/www\n\n# Test file serving\ncurl -I http://localhost:4001\n</code></pre>"},{"location":"services/static-server/#official-documentation","title":"Official Documentation","text":"<p>For more information about the underlying Nginx server: - LinuxServer.io Nginx - Nginx Documentation</p>"},{"location":"blog/archive/2025/","title":"2025","text":""}]} |