admin/freealberta
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
freealberta/mkdocs/site/getting-started/index.html
admin ab81a74ed8 initial commit
2025-05-28 09:47:43 -06:00

1524 lines
40 KiB
HTML
Raw Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="Self-hosted platform for documentation and development">
<meta name="author" content="Bunker Ops">
<link rel="canonical" href="https://changeme.org/getting-started/">
<link rel="prev" href="..">
<link rel="next" href="../services/">
<link rel="icon" href="../assets/images/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.14">
<title>Getting Started - Changemaker Lite Documentation</title>
<link rel="stylesheet" href="../assets/stylesheets/main.342714a4.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../stylesheets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<meta property="og:type" content="website" >
<meta property="og:title" content="Getting Started - Changemaker Lite Documentation" >
<meta property="og:description" content="Self-hosted platform for documentation and development" >
<meta property="og:image" content="https://changeme.org/assets/images/social/getting-started.png" >
<meta property="og:image:type" content="image/png" >
<meta property="og:image:width" content="1200" >
<meta property="og:image:height" content="630" >
<meta property="og:url" content="https://changeme.org/getting-started/" >
<meta name="twitter:card" content="summary_large_image" >
<meta name="twitter:title" content="Getting Started - Changemaker Lite Documentation" >
<meta name="twitter:description" content="Self-hosted platform for documentation and development" >
<meta name="twitter:image" content="https://changeme.org/assets/images/social/getting-started.png" >
</head>
<body dir="ltr" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#getting-started" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
<aside class="md-banner">
<div class="md-banner__inner md-grid md-typeset">
<a href="https://homepage.test.com" class="login-button">Login</a>
Changemaker Archive. <a href="https://docs.bnkops.com">Learn more</a>
</div>
</aside>
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Changemaker Lite Documentation" class="md-header__button md-logo" aria-label="Changemaker Lite Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Changemaker Lite Documentation
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Getting Started
</span>
</div>
</div>
</div>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Getting Started
</a>
</li>
<li class="md-tabs__item">
<a href="../services/" class="md-tabs__link">
Services
</a>
</li>
<li class="md-tabs__item">
<a href="../blog/" class="md-tabs__link">
Index
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Changemaker Lite Documentation" class="md-nav__button md-logo" aria-label="Changemaker Lite Documentation" data-md-component="logo">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54"/></svg>
</a>
Changemaker Lite Documentation
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Getting Started
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Getting Started
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
<nav class="md-nav" aria-label="Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-clone-repository" class="md-nav__link">
<span class="md-ellipsis">
1. Clone Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-configuration" class="md-nav__link">
<span class="md-ellipsis">
2. Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-start-services" class="md-nav__link">
<span class="md-ellipsis">
3. Start Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-verify-installation" class="md-nav__link">
<span class="md-ellipsis">
4. Verify Installation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#first-steps" class="md-nav__link">
<span class="md-ellipsis">
First Steps
</span>
</a>
<nav class="md-nav" aria-label="First Steps">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#access-documentation" class="md-nav__link">
<span class="md-ellipsis">
Access Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#start-coding" class="md-nav__link">
<span class="md-ellipsis">
Start Coding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-email-campaigns" class="md-nav__link">
<span class="md-ellipsis">
Set Up Email Campaigns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-workflows" class="md-nav__link">
<span class="md-ellipsis">
Create Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#manage-data-with-nocodb" class="md-nav__link">
<span class="md-ellipsis">
Manage Data with NocoDB
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#access-all-services-via-homepage" class="md-nav__link">
<span class="md-ellipsis">
Access All Services via Homepage
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configuration-details" class="md-nav__link">
<span class="md-ellipsis">
Configuration Details
</span>
</a>
<nav class="md-nav" aria-label="Configuration Details">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#environment-variables" class="md-nav__link">
<span class="md-ellipsis">
Environment Variables
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#volume-mounts" class="md-nav__link">
<span class="md-ellipsis">
Volume Mounts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-tasks" class="md-nav__link">
<span class="md-ellipsis">
Common Tasks
</span>
</a>
<nav class="md-nav" aria-label="Common Tasks">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#writing-documentation" class="md-nav__link">
<span class="md-ellipsis">
Writing Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#managing-services" class="md-nav__link">
<span class="md-ellipsis">
Managing Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#backup-important-data" class="md-nav__link">
<span class="md-ellipsis">
Backup Important Data
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
<nav class="md-nav" aria-label="Troubleshooting">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#port-conflicts" class="md-nav__link">
<span class="md-ellipsis">
Port Conflicts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#permission-issues" class="md-nav__link">
<span class="md-ellipsis">
Permission Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#service-wont-start" class="md-nav__link">
<span class="md-ellipsis">
Service Won't Start
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-steps" class="md-nav__link">
<span class="md-ellipsis">
Next Steps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#getting-help" class="md-nav__link">
<span class="md-ellipsis">
Getting Help
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_3" >
<div class="md-nav__link md-nav__container">
<a href="../services/" class="md-nav__link ">
<span class="md-ellipsis">
Services
</span>
</a>
<label class="md-nav__link " for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-nav__icon md-icon"></span>
</label>
</div>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
Services
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../services/homepage/" class="md-nav__link">
<span class="md-ellipsis">
Homepage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/code-server/" class="md-nav__link">
<span class="md-ellipsis">
Code Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/mkdocs/" class="md-nav__link">
<span class="md-ellipsis">
MkDocs Material
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/static-server/" class="md-nav__link">
<span class="md-ellipsis">
Static Site Server
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/listmonk/" class="md-nav__link">
<span class="md-ellipsis">
Listmonk
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/postgresql/" class="md-nav__link">
<span class="md-ellipsis">
PostgreSQL
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/n8n/" class="md-nav__link">
<span class="md-ellipsis">
n8n
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../services/nocodb/" class="md-nav__link">
<span class="md-ellipsis">
NocoDB
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../blog/" class="md-nav__link">
<span class="md-ellipsis">
Index
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#prerequisites" class="md-nav__link">
<span class="md-ellipsis">
Prerequisites
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
<nav class="md-nav" aria-label="Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#1-clone-repository" class="md-nav__link">
<span class="md-ellipsis">
1. Clone Repository
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#2-configuration" class="md-nav__link">
<span class="md-ellipsis">
2. Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#3-start-services" class="md-nav__link">
<span class="md-ellipsis">
3. Start Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#4-verify-installation" class="md-nav__link">
<span class="md-ellipsis">
4. Verify Installation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#first-steps" class="md-nav__link">
<span class="md-ellipsis">
First Steps
</span>
</a>
<nav class="md-nav" aria-label="First Steps">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#access-documentation" class="md-nav__link">
<span class="md-ellipsis">
Access Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#start-coding" class="md-nav__link">
<span class="md-ellipsis">
Start Coding
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#set-up-email-campaigns" class="md-nav__link">
<span class="md-ellipsis">
Set Up Email Campaigns
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-workflows" class="md-nav__link">
<span class="md-ellipsis">
Create Workflows
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#manage-data-with-nocodb" class="md-nav__link">
<span class="md-ellipsis">
Manage Data with NocoDB
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#access-all-services-via-homepage" class="md-nav__link">
<span class="md-ellipsis">
Access All Services via Homepage
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#configuration-details" class="md-nav__link">
<span class="md-ellipsis">
Configuration Details
</span>
</a>
<nav class="md-nav" aria-label="Configuration Details">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#environment-variables" class="md-nav__link">
<span class="md-ellipsis">
Environment Variables
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#volume-mounts" class="md-nav__link">
<span class="md-ellipsis">
Volume Mounts
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#common-tasks" class="md-nav__link">
<span class="md-ellipsis">
Common Tasks
</span>
</a>
<nav class="md-nav" aria-label="Common Tasks">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#writing-documentation" class="md-nav__link">
<span class="md-ellipsis">
Writing Documentation
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#managing-services" class="md-nav__link">
<span class="md-ellipsis">
Managing Services
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#backup-important-data" class="md-nav__link">
<span class="md-ellipsis">
Backup Important Data
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#troubleshooting" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
<nav class="md-nav" aria-label="Troubleshooting">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#port-conflicts" class="md-nav__link">
<span class="md-ellipsis">
Port Conflicts
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#permission-issues" class="md-nav__link">
<span class="md-ellipsis">
Permission Issues
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#service-wont-start" class="md-nav__link">
<span class="md-ellipsis">
Service Won't Start
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#next-steps" class="md-nav__link">
<span class="md-ellipsis">
Next Steps
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#getting-help" class="md-nav__link">
<span class="md-ellipsis">
Getting Help
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">&para;</a></h1>
<p>Welcome to Changemaker Lite! This guide will help you get up and running quickly.</p>
<h2 id="prerequisites">Prerequisites<a class="headerlink" href="#prerequisites" title="Permanent link">&para;</a></h2>
<p>Before starting, ensure you have:</p>
<ul>
<li><a href="https://docs.docker.com/get-docker/">Docker</a> installed</li>
<li><a href="https://docs.docker.com/compose/install/">Docker Compose</a> installed</li>
<li>Git for cloning the repository</li>
<li>Basic familiarity with terminal/command line</li>
</ul>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>
<h3 id="1-clone-repository">1. Clone Repository<a class="headerlink" href="#1-clone-repository" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>git<span class="w"> </span>clone<span class="w"> </span>https://gitea.bnkops.com/admin/Changemaker.git
<a id="__codelineno-0-2" name="__codelineno-0-2" href="#__codelineno-0-2"></a><span class="nb">cd</span><span class="w"> </span>changemaker.lite
</code></pre></div>
<h3 id="2-configuration">2. Configuration<a class="headerlink" href="#2-configuration" title="Permanent link">&para;</a></h3>
<p>Run the configuration script to set up environment variables:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>./config.sh
</code></pre></div>
<p>This creates a <code>.env</code> file with default settings. You can edit this file to customize:
- Service ports
- Database credentials
- User/group IDs
- Domain settings</p>
<h3 id="3-start-services">3. Start Services<a class="headerlink" href="#3-start-services" title="Permanent link">&para;</a></h3>
<p>Launch all services with Docker Compose:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<p>Wait a few minutes for all services to start, especially on first run as Docker images need to be downloaded.</p>
<h3 id="4-verify-installation">4. Verify Installation<a class="headerlink" href="#4-verify-installation" title="Permanent link">&para;</a></h3>
<p>Check that services are running:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>ps
</code></pre></div>
<p>All services should show as "Up" status.</p>
<h2 id="first-steps">First Steps<a class="headerlink" href="#first-steps" title="Permanent link">&para;</a></h2>
<h3 id="access-documentation">Access Documentation<a class="headerlink" href="#access-documentation" title="Permanent link">&para;</a></h3>
<ol>
<li><strong>Development Server</strong>: http://localhost:4000</li>
<li>Live preview with auto-reload</li>
<li>
<p>Used while writing documentation</p>
</li>
<li>
<p><strong>Production Server</strong>: http://localhost:4001 </p>
</li>
<li>Serves built static site</li>
<li>Optimized for performance</li>
</ol>
<h3 id="start-coding">Start Coding<a class="headerlink" href="#start-coding" title="Permanent link">&para;</a></h3>
<ol>
<li>Open <strong>Code Server</strong>: http://localhost:8888</li>
<li>Navigate to <code>/home/coder/mkdocs/</code> workspace</li>
<li>Edit documentation files in <code>docs/</code> directory</li>
<li>See changes instantly in development server</li>
</ol>
<h3 id="set-up-email-campaigns">Set Up Email Campaigns<a class="headerlink" href="#set-up-email-campaigns" title="Permanent link">&para;</a></h3>
<ol>
<li>Access <strong>Listmonk</strong>: http://localhost:9000</li>
<li>Log in with admin credentials (set in config)</li>
<li>Configure SMTP settings</li>
<li>Create your first mailing list</li>
</ol>
<h3 id="create-workflows">Create Workflows<a class="headerlink" href="#create-workflows" title="Permanent link">&para;</a></h3>
<ol>
<li>Open <strong>n8n</strong>: http://localhost:5678</li>
<li>Log in with admin credentials</li>
<li>Create your first workflow</li>
<li>Connect different services together</li>
</ol>
<h3 id="manage-data-with-nocodb">Manage Data with NocoDB<a class="headerlink" href="#manage-data-with-nocodb" title="Permanent link">&para;</a></h3>
<ol>
<li>Access <strong>NocoDB</strong>: http://localhost:8090</li>
<li>Complete the initial setup</li>
<li>Create your first project</li>
<li>Import data or create new tables</li>
</ol>
<h3 id="access-all-services-via-homepage">Access All Services via Homepage<a class="headerlink" href="#access-all-services-via-homepage" title="Permanent link">&para;</a></h3>
<ol>
<li>Open <strong>Homepage</strong>: http://localhost:3010</li>
<li>View all services in one dashboard</li>
<li>Monitor service status</li>
<li>Quick access to all applications</li>
</ol>
<h2 id="configuration-details">Configuration Details<a class="headerlink" href="#configuration-details" title="Permanent link">&para;</a></h2>
<h3 id="environment-variables">Environment Variables<a class="headerlink" href="#environment-variables" title="Permanent link">&para;</a></h3>
<p>Key settings in <code>.env</code> file:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a># Service Ports
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a>HOMEPAGE_PORT=3010
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a>CODE_SERVER_PORT=8888
<a id="__codelineno-4-4" name="__codelineno-4-4" href="#__codelineno-4-4"></a>MKDOCS_PORT=4000
<a id="__codelineno-4-5" name="__codelineno-4-5" href="#__codelineno-4-5"></a>MKDOCS_SITE_SERVER_PORT=4001
<a id="__codelineno-4-6" name="__codelineno-4-6" href="#__codelineno-4-6"></a>LISTMONK_PORT=9000
<a id="__codelineno-4-7" name="__codelineno-4-7" href="#__codelineno-4-7"></a>N8N_PORT=5678
<a id="__codelineno-4-8" name="__codelineno-4-8" href="#__codelineno-4-8"></a>NOCODB_PORT=8090
<a id="__codelineno-4-9" name="__codelineno-4-9" href="#__codelineno-4-9"></a>
<a id="__codelineno-4-10" name="__codelineno-4-10" href="#__codelineno-4-10"></a># Database
<a id="__codelineno-4-11" name="__codelineno-4-11" href="#__codelineno-4-11"></a>POSTGRES_USER=listmonk
<a id="__codelineno-4-12" name="__codelineno-4-12" href="#__codelineno-4-12"></a>POSTGRES_PASSWORD=your_secure_password
<a id="__codelineno-4-13" name="__codelineno-4-13" href="#__codelineno-4-13"></a>POSTGRES_DB=listmonk
<a id="__codelineno-4-14" name="__codelineno-4-14" href="#__codelineno-4-14"></a>
<a id="__codelineno-4-15" name="__codelineno-4-15" href="#__codelineno-4-15"></a># User/Group IDs (match your system)
<a id="__codelineno-4-16" name="__codelineno-4-16" href="#__codelineno-4-16"></a>USER_ID=1000
<a id="__codelineno-4-17" name="__codelineno-4-17" href="#__codelineno-4-17"></a>GROUP_ID=1000
</code></pre></div>
<h3 id="volume-mounts">Volume Mounts<a class="headerlink" href="#volume-mounts" title="Permanent link">&para;</a></h3>
<p>Important directories:</p>
<ul>
<li><code>./mkdocs/</code>: Documentation source files</li>
<li><code>./configs/</code>: Service configurations</li>
<li><code>./assets/</code>: Shared assets and uploads</li>
<li>Docker volumes for persistent data</li>
</ul>
<h2 id="common-tasks">Common Tasks<a class="headerlink" href="#common-tasks" title="Permanent link">&para;</a></h2>
<h3 id="writing-documentation">Writing Documentation<a class="headerlink" href="#writing-documentation" title="Permanent link">&para;</a></h3>
<ol>
<li>Edit files in <code>mkdocs/docs/</code> using Code Server</li>
<li>Preview changes at http://localhost:4000</li>
<li>Build static site: <code>docker exec mkdocs-changemaker mkdocs build</code></li>
<li>View built site at http://localhost:4001</li>
</ol>
<h3 id="managing-services">Managing Services<a class="headerlink" href="#managing-services" title="Permanent link">&para;</a></h3>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="c1"># View logs</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a>docker<span class="w"> </span>compose<span class="w"> </span>logs<span class="w"> </span><span class="o">[</span>service-name<span class="o">]</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="c1"># Restart service</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a>docker<span class="w"> </span>compose<span class="w"> </span>restart<span class="w"> </span><span class="o">[</span>service-name<span class="o">]</span>
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a>
<a id="__codelineno-5-7" name="__codelineno-5-7" href="#__codelineno-5-7"></a><span class="c1"># Stop all services</span>
<a id="__codelineno-5-8" name="__codelineno-5-8" href="#__codelineno-5-8"></a>docker<span class="w"> </span>compose<span class="w"> </span>down
<a id="__codelineno-5-9" name="__codelineno-5-9" href="#__codelineno-5-9"></a>
<a id="__codelineno-5-10" name="__codelineno-5-10" href="#__codelineno-5-10"></a><span class="c1"># Update services</span>
<a id="__codelineno-5-11" name="__codelineno-5-11" href="#__codelineno-5-11"></a>docker<span class="w"> </span>compose<span class="w"> </span>pull<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<h3 id="backup-important-data">Backup Important Data<a class="headerlink" href="#backup-important-data" title="Permanent link">&para;</a></h3>
<ul>
<li>Export n8n workflows</li>
<li>Backup PostgreSQL database</li>
<li>Version control your documentation files</li>
<li>Save service configurations</li>
</ul>
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">&para;</a></h2>
<h3 id="port-conflicts">Port Conflicts<a class="headerlink" href="#port-conflicts" title="Permanent link">&para;</a></h3>
<p>If ports are already in use, edit <code>.env</code> file:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>CODE_SERVER_PORT=8889 # Change from 8888
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a>MKDOCS_PORT=4002 # Change from 4000
</code></pre></div>
<p>Then restart: <code>docker compose down &amp;&amp; docker compose up -d</code></p>
<h3 id="permission-issues">Permission Issues<a class="headerlink" href="#permission-issues" title="Permanent link">&para;</a></h3>
<p>Ensure correct user/group IDs in <code>.env</code>:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="c1"># Get your user ID</span>
<a id="__codelineno-7-2" name="__codelineno-7-2" href="#__codelineno-7-2"></a>id<span class="w"> </span>-u
<a id="__codelineno-7-3" name="__codelineno-7-3" href="#__codelineno-7-3"></a>
<a id="__codelineno-7-4" name="__codelineno-7-4" href="#__codelineno-7-4"></a><span class="c1"># Get your group ID </span>
<a id="__codelineno-7-5" name="__codelineno-7-5" href="#__codelineno-7-5"></a>id<span class="w"> </span>-g
</code></pre></div>
<p>Update <code>.env</code> with these values and restart services.</p>
<h3 id="service-wont-start">Service Won't Start<a class="headerlink" href="#service-wont-start" title="Permanent link">&para;</a></h3>
<p>Check logs for specific errors:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>logs<span class="w"> </span><span class="o">[</span>service-name<span class="o">]</span>
</code></pre></div>
<p>Common issues:
- Port conflicts
- Permission problems
- Missing environment variables
- Network connectivity</p>
<h2 id="next-steps">Next Steps<a class="headerlink" href="#next-steps" title="Permanent link">&para;</a></h2>
<ul>
<li>Explore the <a href="../services/">Services</a> documentation</li>
<li>Set up your first <a href="../services/n8n/">n8n workflow</a></li>
<li>Configure <a href="../services/listmonk/">Listmonk</a> for email campaigns</li>
<li>Customize your <a href="../services/mkdocs/">MkDocs</a> theme and content</li>
</ul>
<h2 id="getting-help">Getting Help<a class="headerlink" href="#getting-help" title="Permanent link">&para;</a></h2>
<ul>
<li>Check service-specific documentation</li>
<li>Review Docker container logs</li>
<li>Verify environment configuration</li>
<li>Test network connectivity between services</li>
</ul>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2024 The Bunker Operations - Built with Change Maker
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tracking", "navigation.indexes", "navigation.collapse", "navigation.path", "content.code.copy", "navigation.top", "navigation.tabs"], "search": "../assets/javascripts/workers/search.d50fe291.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../assets/javascripts/bundle.13a4f30d.min.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink