8009 lines
178 KiB
HTML
8009 lines
178 KiB
HTML
|
||
<!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="Build Power. Not Rent It. Own your digital infrastructure.">
|
||
|
||
|
||
<meta name="author" content="Bunker Operations">
|
||
|
||
|
||
<link rel="canonical" href="https://bnkserve.org/v2/user-guides/admin-guide/">
|
||
|
||
|
||
<link rel="prev" href="../">
|
||
|
||
|
||
<link rel="next" href="../campaign-manager-guide/">
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="icon" href="../../../assets/favicon.png">
|
||
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.7.1">
|
||
|
||
|
||
|
||
<title>Admin Guide - Changemaker Lite</title>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../../assets/stylesheets/main.484c7ddc.min.css">
|
||
|
||
|
||
<link rel="stylesheet" href="../../../assets/stylesheets/palette.ab4e12ef.min.css">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
|
||
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Inter:300,300i,400,400i,700,700i%7CJetBrains+Mono:400,400i,700,700i&display=fallback">
|
||
<style>:root{--md-text-font:"Inter";--md-code-font:"JetBrains Mono"}</style>
|
||
|
||
|
||
|
||
<link rel="stylesheet" href="../../../stylesheets/extra.css">
|
||
|
||
<link rel="stylesheet" href="../../../stylesheets/home.css">
|
||
|
||
<link rel="stylesheet" href="../../../assets/css/video-player.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="Admin Guide - Changemaker Lite" />
|
||
<meta property="og:description" content="Build Power. Not Rent It. Own your digital infrastructure." />
|
||
<meta property="og:image" content="https://bnkserve.org/assets/images/social/v2/user-guides/admin-guide.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://bnkserve.org/v2/user-guides/admin-guide/" />
|
||
<meta property="twitter:card" content="summary_large_image" />
|
||
<meta property="twitter:title" content="Admin Guide - Changemaker Lite" />
|
||
<meta property="twitter:description" content="Build Power. Not Rent It. Own your digital infrastructure." />
|
||
<meta property="twitter:image" content="https://bnkserve.org/assets/images/social/v2/user-guides/admin-guide.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="#administrator-guide" class="md-skip">
|
||
Skip to content
|
||
</a>
|
||
|
||
</div>
|
||
<div data-md-component="announce">
|
||
|
||
</div>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
|
||
<nav class="md-header__inner md-grid" aria-label="Header">
|
||
<a href="../../.." title="Changemaker Lite" class="md-header__button md-logo" aria-label="Changemaker Lite" data-md-component="logo">
|
||
|
||
<img src="../../../assets/logo.png" alt="logo">
|
||
|
||
</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
|
||
</span>
|
||
</div>
|
||
<div class="md-header__topic" data-md-component="header-topic">
|
||
<span class="md-ellipsis">
|
||
|
||
Admin Guide
|
||
|
||
</span>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
<form class="md-header__option" data-md-component="palette">
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="" data-md-color-scheme="slate" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m17.75 4.09-2.53 1.94.91 3.06-2.63-1.81-2.63 1.81.91-3.06-2.53-1.94L12.44 4l1.06-3 1.06 3zm3.5 6.91-1.64 1.25.59 1.98-1.7-1.17-1.7 1.17.59-1.98L15.75 11l2.06-.05L18.5 9l.69 1.95zm-2.28 4.95c.83-.08 1.72 1.1 1.19 1.85-.32.45-.66.87-1.08 1.27C15.17 23 8.84 23 4.94 19.07c-3.91-3.9-3.91-10.24 0-14.14.4-.4.82-.76 1.27-1.08.75-.53 1.93.36 1.85 1.19-.27 2.86.69 5.83 2.89 8.02a9.96 9.96 0 0 0 8.02 2.89m-1.64 2.02a12.08 12.08 0 0 1-7.8-3.47c-2.17-2.19-3.33-5-3.49-7.82-2.81 3.14-2.7 7.96.31 10.98 3.02 3.01 7.84 3.12 10.98.31"/></svg>
|
||
</label>
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-option" data-md-color-media="" data-md-color-scheme="default" data-md-color-primary="deep-purple" data-md-color-accent="amber" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
|
||
|
||
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_0" hidden>
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 7a5 5 0 0 1 5 5 5 5 0 0 1-5 5 5 5 0 0 1-5-5 5 5 0 0 1 5-5m0 2a3 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-7 2.39 3.42C13.65 5.15 12.84 5 12 5s-1.65.15-2.39.42zM3.34 7l4.16-.35A7.2 7.2 0 0 0 5.94 8.5c-.44.74-.69 1.5-.83 2.29zm.02 10 1.76-3.77a7.131 7.131 0 0 0 2.38 4.14zM20.65 7l-1.77 3.79a7.02 7.02 0 0 0-2.38-4.15zm-.01 10-4.14.36c.59-.51 1.12-1.14 1.54-1.86.42-.73.69-1.5.83-2.29zM12 22l-2.41-3.44c.74.27 1.55.44 2.41.44.82 0 1.63-.17 2.37-.44z"/></svg>
|
||
</label>
|
||
|
||
|
||
</form>
|
||
|
||
|
||
|
||
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
|
||
|
||
|
||
|
||
|
||
|
||
<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">
|
||
|
||
<a href="javascript:void(0)" class="md-search__icon md-icon" title="Share" aria-label="Share" data-clipboard data-clipboard-text="" data-md-component="search-share" tabindex="-1">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M18 16.08c-.76 0-1.44.3-1.96.77L8.91 12.7c.05-.23.09-.46.09-.7s-.04-.47-.09-.7l7.05-4.11c.54.5 1.25.81 2.04.81a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3c0 .24.04.47.09.7L8.04 9.81C7.5 9.31 6.79 9 6 9a3 3 0 0 0-3 3 3 3 0 0 0 3 3c.79 0 1.5-.31 2.04-.81l7.12 4.15c-.05.21-.08.43-.08.66 0 1.61 1.31 2.91 2.92 2.91s2.92-1.3 2.92-2.91A2.92 2.92 0 0 0 18 16.08"/></svg>
|
||
</a>
|
||
|
||
<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>
|
||
|
||
<div class="md-search__suggest" data-md-component="search-suggest"></div>
|
||
|
||
</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>
|
||
|
||
|
||
|
||
<div class="md-header__source">
|
||
<a href="https://gitea.bnkops.com/admin/changemaker.lite" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
changemaker.lite
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
</nav>
|
||
|
||
|
||
|
||
<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">
|
||
|
||
|
||
|
||
|
||
|
||
V2 Documentation
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../../phil/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Philosophy
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../../v1/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
V1 Documentation (Legacy)
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-tabs__item">
|
||
<a href="../../../blog/" class="md-tabs__link">
|
||
|
||
|
||
|
||
|
||
|
||
Blog
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</div>
|
||
</nav>
|
||
|
||
|
||
</header>
|
||
|
||
<div class="md-container" data-md-component="container">
|
||
|
||
|
||
|
||
|
||
<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" class="md-nav__button md-logo" aria-label="Changemaker Lite" data-md-component="logo">
|
||
|
||
<img src="../../../assets/logo.png" alt="logo">
|
||
|
||
</a>
|
||
Changemaker Lite
|
||
</label>
|
||
|
||
<div class="md-nav__source">
|
||
<a href="https://gitea.bnkops.com/admin/changemaker.lite" title="Go to repository" class="md-source" data-md-component="source">
|
||
<div class="md-source__icon md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
|
||
</div>
|
||
<div class="md-source__repository">
|
||
changemaker.lite
|
||
</div>
|
||
</a>
|
||
</div>
|
||
|
||
<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 md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
V2 Documentation
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2" id="__nav_2_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
|
||
<label class="md-nav__title" for="__nav_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
V2 Documentation
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_2" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../getting-started/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Getting Started
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_2" id="__nav_2_2_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_2_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_2">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Getting Started
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../getting-started/quick-start/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Quick Start
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_3" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../architecture/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Architecture
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_3" id="__nav_2_3_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_3_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_3">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Architecture
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../architecture/dual-api/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Dual API System
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../architecture/authentication/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Authentication & Security
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_4" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../backend/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Backend
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_4" id="__nav_2_4_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_4_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_4">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Backend
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../backend/modules/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Modules
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../backend/services/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Services
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../backend/middleware/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Middleware
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../backend/utilities/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Utilities
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_5" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../frontend/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Frontend
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_5" id="__nav_2_5_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_5_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_5">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Frontend
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../frontend/components/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Components
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../frontend/layouts/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Layouts
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../frontend/pages/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Pages
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_6" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../database/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Database
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_6" id="__nav_2_6_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_6_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_6">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Database
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../database/schema/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Schema Overview
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../database/migrations/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Migrations
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../database/seeding/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Seeding
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../database/indexes/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Indexes
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../database/models/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Models
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_7" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../features/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Features
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_7" id="__nav_2_7_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_7_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_7">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Features
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/influence/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Influence
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/map/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Map
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/landing-pages/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Landing Pages
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/email-templates/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Email Templates
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/media/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Media
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/newsletter/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Newsletter
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/observability/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Observability
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../features/tunnel/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Tunnel
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_8" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../deployment/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Deployment
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_8" id="__nav_2_8_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_8_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_8">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Deployment
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/docker-compose/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Docker Compose
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/environment-variables/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Environment Variables
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/nginx/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Nginx Configuration
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/ssl-tls/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
SSL/TLS
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/tunneling/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Tunneling
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/monitoring-stack/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Monitoring Stack
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/healthchecks/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Health Checks
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/scaling/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Scaling
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../deployment/backup-restore/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Backup & Restore
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_9" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../development/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Development
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_9" id="__nav_2_9_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_9_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_9">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Development
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/local-setup/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Local Setup
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/docker-workflow/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Docker Workflow
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/git-workflow/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Git Workflow
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/npm-commands/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
NPM Commands
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/migrations/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Migrations
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/typescript/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
TypeScript
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/testing/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Testing
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/debugging/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Debugging
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../development/code-style/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Code Style
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_10" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../api-reference/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
API Reference
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_10_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_10">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
API Reference
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2_11" checked>
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
User Guides
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_11" id="__nav_2_11_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_11_label" aria-expanded="true">
|
||
<label class="md-nav__title" for="__nav_2_11">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
User Guides
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<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">
|
||
|
||
|
||
Admin Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Admin Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-nav md-nav--secondary" aria-label="On this page">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
On this page
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#getting-started" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Getting Started
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Getting Started">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#first-login" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
First Login
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#dashboard-overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Dashboard Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#changing-your-password" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Changing Your Password
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#navigating-the-admin-interface" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Navigating the Admin Interface
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#user-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
User Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="User Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#understanding-roles" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Understanding Roles
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Understanding Roles">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#1-super_admin-you" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
1. SUPER_ADMIN (You)
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#2-influence_admin" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
2. INFLUENCE_ADMIN
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#3-map_admin" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
3. MAP_ADMIN
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#4-user" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
4. USER
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#5-temp" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
5. TEMP
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-existing-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing Existing Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#editing-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Editing Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#suspending-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Suspending Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#password-resets" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Password Resets
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#deleting-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Deleting Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#viewing-login-activity" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Viewing Login Activity
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#campaign-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Campaign Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Campaign Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#campaign-overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Campaign Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-a-campaign" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating a Campaign
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#understanding-feature-flags" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Understanding Feature Flags
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Understanding Feature Flags">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#core-features" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Core Features
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#advanced-features" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Advanced Features
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#configuring-email-template" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Configuring Email Template
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#publishing-a-campaign" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Publishing a Campaign
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#monitoring-email-sends" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Monitoring Email Sends
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-the-email-queue" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing the Email Queue
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#moderating-responses" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Moderating Responses
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#location-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Location Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Location Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#location-data-overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Location Data Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#importing-locations-from-csv" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Importing Locations from CSV
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#nar-import-canadian-electoral-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
NAR Import (Canadian Electoral Data)
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#geocoding-addresses" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Geocoding Addresses
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-cuts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating Cuts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#assigning-locations-to-cuts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Assigning Locations to Cuts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-locations" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing Locations
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#exporting-walk-sheets" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Exporting Walk Sheets
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#volunteer-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Volunteer Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Volunteer Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-shifts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating Shifts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-shift-signups" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing Shift Signups
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#emailing-shift-volunteers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Emailing Shift Volunteers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#monitoring-canvass-sessions" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Monitoring Canvass Sessions
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#viewing-canvass-activity-reports" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Viewing Canvass Activity Reports
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#site-configuration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Site Configuration
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Site Configuration">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#site-settings" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Site Settings
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#map-settings" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Map Settings
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#feature-toggles" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Feature Toggles
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#email-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Email Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Email Templates">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#understanding-email-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Understanding Email Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#editing-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Editing Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#available-variables" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Available Variables
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#testing-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Testing Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#media-library" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Media Library
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Media Library">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#uploading-videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Uploading Videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#automatic-metadata-extraction" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Automatic Metadata Extraction
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#organizing-the-library" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Organizing the Library
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sharing-videos-publicly" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Sharing Videos Publicly
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#locking-videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Locking Videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#monitoring-reports" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Monitoring & Reports
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Monitoring & Reports">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#viewing-queue-status" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Viewing Queue Status
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#geocoding-quality-dashboard" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Geocoding Quality Dashboard
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#canvass-completion-statistics" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Canvass Completion Statistics
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#observability-dashboard" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Observability Dashboard
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Observability Dashboard">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#metrics-tab" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Metrics Tab
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#dashboards-tab" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Dashboards Tab
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#alerts-tab" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Alerts Tab
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</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="#common-admin-issues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Common Admin Issues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Common Admin Issues">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-cannot-log-in" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Cannot Log In
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-emails-not-sending" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Emails Not Sending
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-csv-import-fails" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: CSV Import Fails
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-geocoding-fails" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Geocoding Fails
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-map-not-loading" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Map Not Loading
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-campaign-not-appearing-publicly" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Campaign Not Appearing Publicly
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-volunteer-cannot-start-canvass-session" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Volunteer Cannot Start Canvass Session
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</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">
|
||
<a href="#related-documentation" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Related Documentation
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../campaign-manager-guide/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Campaign Manager Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../map-organizer-guide/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Map Organizer Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../content-editor-guide/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Content Editor Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../volunteer-guide/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Volunteer Guide
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_12" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../troubleshooting/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Troubleshooting
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_12" id="__nav_2_12_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_12_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_12">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Troubleshooting
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/faq/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
FAQ
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/common-errors/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Common Errors
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/auth-issues/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Auth Issues
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/database-issues/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Database Issues
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/docker-issues/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Docker Issues
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/email-issues/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Email Issues
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/geocoding-issues/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Geocoding Issues
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/monitoring-issues/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Monitoring Issues
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../troubleshooting/performance-optimization/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Performance Optimization
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_13" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../migration/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Migration
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_13" id="__nav_2_13_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_13_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_13">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Migration
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../migration/feature-parity/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Feature Parity
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../migration/breaking-changes/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Breaking Changes
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../migration/api-changes/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
API Changes
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../migration/data-migration/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Data Migration
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--section md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_2_14" >
|
||
|
||
|
||
<div class="md-nav__link md-nav__container">
|
||
<a href="../../contributing/" class="md-nav__link ">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Contributing
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
|
||
|
||
<label class="md-nav__link " for="__nav_2_14" id="__nav_2_14_label" tabindex="">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
</label>
|
||
|
||
</div>
|
||
|
||
<nav class="md-nav" data-md-level="2" aria-labelledby="__nav_2_14_label" aria-expanded="false">
|
||
<label class="md-nav__title" for="__nav_2_14">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
|
||
Contributing
|
||
|
||
|
||
</label>
|
||
<ul class="md-nav__list" data-md-scrollfix>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../contributing/development-setup/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Development Setup
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../contributing/code-of-conduct/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Code of Conduct
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../contributing/pull-requests/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Pull Requests
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item">
|
||
<a href="../../contributing/roadmap/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Roadmap
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../../phil/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Philosophy
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../../v1/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
V1 Documentation (Legacy)
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></span>
|
||
|
||
</a>
|
||
|
||
|
||
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-nav__item md-nav__item--pruned md-nav__item--nested">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="../../../blog/" class="md-nav__link">
|
||
|
||
|
||
|
||
<span class="md-ellipsis">
|
||
|
||
|
||
Blog
|
||
|
||
|
||
|
||
</span>
|
||
|
||
|
||
|
||
|
||
<span class="md-nav__icon md-icon"></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="On this page">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<label class="md-nav__title" for="__toc">
|
||
<span class="md-nav__icon md-icon"></span>
|
||
On this page
|
||
</label>
|
||
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#getting-started" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Getting Started
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Getting Started">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#first-login" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
First Login
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#dashboard-overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Dashboard Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#changing-your-password" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Changing Your Password
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#navigating-the-admin-interface" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Navigating the Admin Interface
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#user-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
User Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="User Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#understanding-roles" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Understanding Roles
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Understanding Roles">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#1-super_admin-you" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
1. SUPER_ADMIN (You)
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#2-influence_admin" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
2. INFLUENCE_ADMIN
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#3-map_admin" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
3. MAP_ADMIN
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#4-user" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
4. USER
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#5-temp" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
5. TEMP
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-existing-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing Existing Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#editing-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Editing Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#suspending-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Suspending Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#password-resets" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Password Resets
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#deleting-users" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Deleting Users
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#viewing-login-activity" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Viewing Login Activity
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#campaign-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Campaign Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Campaign Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#campaign-overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Campaign Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-a-campaign" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating a Campaign
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#understanding-feature-flags" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Understanding Feature Flags
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Understanding Feature Flags">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#core-features" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Core Features
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#advanced-features" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Advanced Features
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#configuring-email-template" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Configuring Email Template
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#publishing-a-campaign" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Publishing a Campaign
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#monitoring-email-sends" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Monitoring Email Sends
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-the-email-queue" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing the Email Queue
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#moderating-responses" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Moderating Responses
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#location-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Location Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Location Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#location-data-overview" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Location Data Overview
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#importing-locations-from-csv" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Importing Locations from CSV
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#nar-import-canadian-electoral-data" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
NAR Import (Canadian Electoral Data)
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#geocoding-addresses" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Geocoding Addresses
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-cuts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating Cuts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#assigning-locations-to-cuts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Assigning Locations to Cuts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-locations" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing Locations
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#exporting-walk-sheets" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Exporting Walk Sheets
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#volunteer-management" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Volunteer Management
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Volunteer Management">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#creating-shifts" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Creating Shifts
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#managing-shift-signups" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Managing Shift Signups
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#emailing-shift-volunteers" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Emailing Shift Volunteers
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#monitoring-canvass-sessions" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Monitoring Canvass Sessions
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#viewing-canvass-activity-reports" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Viewing Canvass Activity Reports
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#site-configuration" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Site Configuration
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Site Configuration">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#site-settings" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Site Settings
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#map-settings" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Map Settings
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#feature-toggles" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Feature Toggles
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#email-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Email Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Email Templates">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#understanding-email-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Understanding Email Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#editing-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Editing Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#available-variables" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Available Variables
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#testing-templates" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Testing Templates
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#media-library" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Media Library
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Media Library">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#uploading-videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Uploading Videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#automatic-metadata-extraction" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Automatic Metadata Extraction
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#organizing-the-library" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Organizing the Library
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#sharing-videos-publicly" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Sharing Videos Publicly
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#locking-videos" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Locking Videos
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#monitoring-reports" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Monitoring & Reports
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Monitoring & Reports">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#viewing-queue-status" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Viewing Queue Status
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#geocoding-quality-dashboard" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Geocoding Quality Dashboard
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#canvass-completion-statistics" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Canvass Completion Statistics
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#observability-dashboard" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Observability Dashboard
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Observability Dashboard">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#metrics-tab" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Metrics Tab
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#dashboards-tab" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Dashboards Tab
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#alerts-tab" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Alerts Tab
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</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="#common-admin-issues" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Common Admin Issues
|
||
|
||
</span>
|
||
</a>
|
||
|
||
<nav class="md-nav" aria-label="Common Admin Issues">
|
||
<ul class="md-nav__list">
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-cannot-log-in" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Cannot Log In
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-emails-not-sending" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Emails Not Sending
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-csv-import-fails" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: CSV Import Fails
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-geocoding-fails" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Geocoding Fails
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-map-not-loading" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Map Not Loading
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-campaign-not-appearing-publicly" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Campaign Not Appearing Publicly
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
<li class="md-nav__item">
|
||
<a href="#issue-volunteer-cannot-start-canvass-session" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Issue: Volunteer Cannot Start Canvass Session
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
</nav>
|
||
|
||
</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">
|
||
<a href="#related-documentation" class="md-nav__link">
|
||
<span class="md-ellipsis">
|
||
|
||
Related Documentation
|
||
|
||
</span>
|
||
</a>
|
||
|
||
</li>
|
||
|
||
</ul>
|
||
|
||
</nav>
|
||
</div>
|
||
</div>
|
||
</div>
|
||
|
||
|
||
|
||
<div class="md-content" data-md-component="content">
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<nav class="md-path" aria-label="Navigation" >
|
||
<ol class="md-path__list">
|
||
|
||
|
||
|
||
|
||
<li class="md-path__item">
|
||
<a href="../../.." class="md-path__link">
|
||
|
||
<span class="md-ellipsis">
|
||
Home
|
||
</span>
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-path__item">
|
||
<a href="../../" class="md-path__link">
|
||
|
||
<span class="md-ellipsis">
|
||
V2 Documentation
|
||
</span>
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
<li class="md-path__item">
|
||
<a href="../" class="md-path__link">
|
||
|
||
<span class="md-ellipsis">
|
||
User Guides
|
||
</span>
|
||
|
||
</a>
|
||
</li>
|
||
|
||
|
||
|
||
|
||
</ol>
|
||
</nav>
|
||
|
||
|
||
<article class="md-content__inner md-typeset">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="https://gitea.bnkops.com/admin/changemaker.lite/src/branch/main/mkdocs/docs/v2/user-guides/admin-guide.md" title="Edit this page" class="md-content__button md-icon" rel="edit">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M10 20H6V4h7v5h5v3.1l2-2V8l-6-6H6c-1.1 0-2 .9-2 2v16c0 1.1.9 2 2 2h4zm10.2-7c.1 0 .3.1.4.2l1.3 1.3c.2.2.2.6 0 .8l-1 1-2.1-2.1 1-1c.1-.1.2-.2.4-.2m0 3.9L14.1 23H12v-2.1l6.1-6.1z"/></svg>
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
<a href="https://gitea.bnkops.com/admin/changemaker.lite/src/branch/main/mkdocs/docs/v2/user-guides/admin-guide.md" title="View source of this page" class="md-content__button md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 18c.56 0 1 .44 1 1s-.44 1-1 1-1-.44-1-1 .44-1 1-1m0-3c-2.73 0-5.06 1.66-6 4 .94 2.34 3.27 4 6 4s5.06-1.66 6-4c-.94-2.34-3.27-4-6-4m0 6.5a2.5 2.5 0 0 1-2.5-2.5 2.5 2.5 0 0 1 2.5-2.5 2.5 2.5 0 0 1 2.5 2.5 2.5 2.5 0 0 1-2.5 2.5M9.27 20H6V4h7v5h5v4.07c.7.08 1.36.25 2 .49V8l-6-6H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h4.5a8.2 8.2 0 0 1-1.23-2"/></svg>
|
||
</a>
|
||
|
||
|
||
|
||
<h1 id="administrator-guide">Administrator Guide<a class="headerlink" href="#administrator-guide" title="Permanent link">¶</a></h1>
|
||
<h2 id="overview">Overview<a class="headerlink" href="#overview" title="Permanent link">¶</a></h2>
|
||
<p>The Administrator role is the highest-level role in Changemaker Lite. As an administrator, you have complete control over the platform, including:</p>
|
||
<ul>
|
||
<li><strong>User management</strong>: Create, edit, suspend, and delete user accounts</li>
|
||
<li><strong>Campaign oversight</strong>: Manage all advocacy campaigns and moderate responses</li>
|
||
<li><strong>Location and mapping</strong>: Import locations, create territorial cuts, and organize canvassing efforts</li>
|
||
<li><strong>Volunteer coordination</strong>: Create shifts, manage signups, and monitor canvassing activity</li>
|
||
<li><strong>Site configuration</strong>: Configure global settings, themes, email, and feature toggles</li>
|
||
<li><strong>Content management</strong>: Create landing pages, edit email templates, and manage media library</li>
|
||
<li><strong>Monitoring</strong>: View queue status, geocoding quality, and system health</li>
|
||
</ul>
|
||
<p>This guide will walk you through all administrative functions in Changemaker Lite V2.</p>
|
||
<hr />
|
||
<h2 id="getting-started">Getting Started<a class="headerlink" href="#getting-started" title="Permanent link">¶</a></h2>
|
||
<h3 id="first-login">First Login<a class="headerlink" href="#first-login" title="Permanent link">¶</a></h3>
|
||
<p>When you first access Changemaker Lite, you'll log in at the admin portal URL:</p>
|
||
<div class="language-text highlight"><pre><span></span><code><span id="__span-0-1"><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>https://app.cmlite.org
|
||
</span></code></pre></div>
|
||
<p>Or if running locally:</p>
|
||
<div class="language-text highlight"><pre><span></span><code><span id="__span-1-1"><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>http://localhost:3000
|
||
</span></code></pre></div>
|
||
<p><strong>Default credentials</strong> (change immediately after first login):</p>
|
||
<ul>
|
||
<li><strong>Email</strong>: <code>admin@example.com</code></li>
|
||
<li><strong>Password</strong>: <code>Admin123!</code></li>
|
||
</ul>
|
||
<div class="admonition danger">
|
||
<p class="admonition-title">Security Critical</p>
|
||
<p>The default password is publicly known. Change it immediately after your first login to prevent unauthorized access.</p>
|
||
</div>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Login page showing email/password fields and "Remember me" checkbox</em></p>
|
||
<h3 id="dashboard-overview">Dashboard Overview<a class="headerlink" href="#dashboard-overview" title="Permanent link">¶</a></h3>
|
||
<p>After logging in, you'll see the Administrator Dashboard, which provides an at-a-glance overview of your platform:</p>
|
||
<p><strong>Key dashboard sections:</strong></p>
|
||
<ol>
|
||
<li><strong>Statistics Cards</strong></li>
|
||
<li>Total users (breakdown by role)</li>
|
||
<li>Active campaigns</li>
|
||
<li>Total locations</li>
|
||
<li>
|
||
<p>Active canvass sessions</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Recent Activity Feed</strong></p>
|
||
</li>
|
||
<li>New user registrations</li>
|
||
<li>Campaign responses</li>
|
||
<li>Shift signups</li>
|
||
<li>
|
||
<p>Canvass visits</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Quick Actions</strong></p>
|
||
</li>
|
||
<li>Create new campaign</li>
|
||
<li>Import locations</li>
|
||
<li>Create volunteer shift</li>
|
||
<li>
|
||
<p>View email queue</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>System Health</strong></p>
|
||
</li>
|
||
<li>API status</li>
|
||
<li>Database connectivity</li>
|
||
<li>Redis cache status</li>
|
||
<li>Queue worker status</li>
|
||
</ol>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Dashboard showing statistics cards, activity feed, and quick action buttons</em></p>
|
||
<h3 id="changing-your-password">Changing Your Password<a class="headerlink" href="#changing-your-password" title="Permanent link">¶</a></h3>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Required First Step</p>
|
||
<p>You must change the default password before performing any other administrative tasks.</p>
|
||
</div>
|
||
<p><strong>To change your password:</strong></p>
|
||
<ol>
|
||
<li>Click your email address in the top-right corner</li>
|
||
<li>Select <strong>"Change Password"</strong> from the dropdown</li>
|
||
<li>Enter your current password</li>
|
||
<li>Enter new password (must meet requirements below)</li>
|
||
<li>Confirm new password</li>
|
||
<li>Click <strong>"Update Password"</strong></li>
|
||
</ol>
|
||
<p><strong>Password requirements:</strong></p>
|
||
<ul>
|
||
<li>Minimum 12 characters</li>
|
||
<li>At least one uppercase letter (A-Z)</li>
|
||
<li>At least one lowercase letter (a-z)</li>
|
||
<li>At least one digit (0-9)</li>
|
||
<li>Cannot reuse recent passwords</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Change password modal showing current/new password fields and requirements checklist</em></p>
|
||
<h3 id="navigating-the-admin-interface">Navigating the Admin Interface<a class="headerlink" href="#navigating-the-admin-interface" title="Permanent link">¶</a></h3>
|
||
<p>The admin interface uses a sidebar navigation with the following sections:</p>
|
||
<p><strong>Main Navigation:</strong></p>
|
||
<ul>
|
||
<li><strong>Dashboard</strong> — Overview and quick actions</li>
|
||
<li><strong>Influence</strong> — Campaigns, responses, representatives, email queue</li>
|
||
<li><strong>Map</strong> — Locations, cuts, shifts, map settings, data quality</li>
|
||
<li><strong>Canvass</strong> — Dashboard, sessions, activity reports</li>
|
||
<li><strong>Content</strong> — Landing pages, email templates, media library</li>
|
||
<li><strong>Services</strong> — Listmonk, Pangolin, docs, integrations</li>
|
||
<li><strong>Observability</strong> — Monitoring, metrics, alerts</li>
|
||
<li><strong>Users</strong> — User management</li>
|
||
<li><strong>Settings</strong> — Global site settings</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Sidebar navigation showing expanded Influence and Map sections</em></p>
|
||
<hr />
|
||
<h2 id="user-management">User Management<a class="headerlink" href="#user-management" title="Permanent link">¶</a></h2>
|
||
<h3 id="creating-users">Creating Users<a class="headerlink" href="#creating-users" title="Permanent link">¶</a></h3>
|
||
<p><strong>To create a new user:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Users</strong> in the sidebar</li>
|
||
<li>Click <strong>"Create User"</strong> button (top-right)</li>
|
||
<li>Fill in user details:</li>
|
||
<li><strong>Email</strong>: User's email address (must be unique)</li>
|
||
<li><strong>Name</strong>: User's full name</li>
|
||
<li><strong>Password</strong>: Temporary password (user should change on first login)</li>
|
||
<li><strong>Role</strong>: Select from dropdown (see roles below)</li>
|
||
<li><strong>Status</strong>: ACTIVE or SUSPENDED</li>
|
||
<li>Click <strong>"Create"</strong></li>
|
||
</ol>
|
||
<p>The new user will receive a welcome email (if email is configured) with their login credentials.</p>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Create User modal showing email, name, password, role dropdown, and status toggle</em></p>
|
||
<h3 id="understanding-roles">Understanding Roles<a class="headerlink" href="#understanding-roles" title="Permanent link">¶</a></h3>
|
||
<p>Changemaker Lite has five user roles with different permission levels:</p>
|
||
<h4 id="1-super_admin-you">1. SUPER_ADMIN (You)<a class="headerlink" href="#1-super_admin-you" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Access</strong>: Everything</li>
|
||
<li><strong>Capabilities</strong>: All administrative functions, user management, site configuration</li>
|
||
<li><strong>Use case</strong>: Primary administrator(s)</li>
|
||
</ul>
|
||
<h4 id="2-influence_admin">2. INFLUENCE_ADMIN<a class="headerlink" href="#2-influence_admin" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Access</strong>: Influence module only</li>
|
||
<li><strong>Capabilities</strong>:</li>
|
||
<li>Create and manage campaigns</li>
|
||
<li>Moderate responses</li>
|
||
<li>View representative cache</li>
|
||
<li>Monitor email queue</li>
|
||
<li><strong>Restrictions</strong>: Cannot manage users, locations, or site settings</li>
|
||
<li><strong>Use case</strong>: Campaign managers who don't need full admin access</li>
|
||
</ul>
|
||
<h4 id="3-map_admin">3. MAP_ADMIN<a class="headerlink" href="#3-map_admin" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Access</strong>: Map module only</li>
|
||
<li><strong>Capabilities</strong>:</li>
|
||
<li>Import and manage locations</li>
|
||
<li>Create cuts</li>
|
||
<li>Organize shifts</li>
|
||
<li>Monitor canvassing</li>
|
||
<li><strong>Restrictions</strong>: Cannot manage users, campaigns, or site settings</li>
|
||
<li><strong>Use case</strong>: Field organizers, volunteer coordinators</li>
|
||
</ul>
|
||
<h4 id="4-user">4. USER<a class="headerlink" href="#4-user" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Access</strong>: Volunteer portal only</li>
|
||
<li><strong>Capabilities</strong>:</li>
|
||
<li>View assigned shifts</li>
|
||
<li>Start canvassing sessions</li>
|
||
<li>Record door visits</li>
|
||
<li>View own activity</li>
|
||
<li><strong>Restrictions</strong>: Cannot access admin areas</li>
|
||
<li><strong>Use case</strong>: Regular volunteers</li>
|
||
</ul>
|
||
<h4 id="5-temp">5. TEMP<a class="headerlink" href="#5-temp" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Access</strong>: Very limited, volunteer portal only</li>
|
||
<li><strong>Capabilities</strong>:</li>
|
||
<li>Sign up for public shifts (creates TEMP account automatically)</li>
|
||
<li>Cannot start canvassing sessions</li>
|
||
<li><strong>Restrictions</strong>: Cannot access most features until upgraded to USER</li>
|
||
<li><strong>Use case</strong>: Anonymous shift signups (converted to USER by admin)</li>
|
||
</ul>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Role Upgrading</p>
|
||
<p>You can upgrade TEMP users to USER role to give them full volunteer access. This is common after a volunteer attends their first shift.</p>
|
||
</div>
|
||
<p><strong>Screenshot placeholder</strong>: <em>User list table showing users with different roles and color-coded role badges</em></p>
|
||
<h3 id="managing-existing-users">Managing Existing Users<a class="headerlink" href="#managing-existing-users" title="Permanent link">¶</a></h3>
|
||
<p>The <strong>Users</strong> page shows all user accounts in a searchable, filterable table.</p>
|
||
<p><strong>Table columns:</strong></p>
|
||
<ul>
|
||
<li><strong>Name</strong> — User's full name</li>
|
||
<li><strong>Email</strong> — Login email</li>
|
||
<li><strong>Role</strong> — Current role (color-coded badge)</li>
|
||
<li><strong>Status</strong> — ACTIVE (green) or SUSPENDED (red)</li>
|
||
<li><strong>Last Login</strong> — Most recent login timestamp</li>
|
||
<li><strong>Created</strong> — Account creation date</li>
|
||
<li><strong>Actions</strong> — Edit, suspend/activate, delete</li>
|
||
</ul>
|
||
<p><strong>Available filters:</strong></p>
|
||
<ul>
|
||
<li><strong>Search</strong>: Search by name or email</li>
|
||
<li><strong>Role filter</strong>: Show only specific roles</li>
|
||
<li><strong>Status filter</strong>: Active, suspended, or all</li>
|
||
<li><strong>Date range</strong>: Filter by creation date</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Users table with search bar, role filter dropdown, and action buttons</em></p>
|
||
<h3 id="editing-users">Editing Users<a class="headerlink" href="#editing-users" title="Permanent link">¶</a></h3>
|
||
<p><strong>To edit a user:</strong></p>
|
||
<ol>
|
||
<li>Click the <strong>Edit</strong> icon (pencil) in the Actions column</li>
|
||
<li>Modify any of:</li>
|
||
<li>Name</li>
|
||
<li>Email (must remain unique)</li>
|
||
<li>Role (change permissions)</li>
|
||
<li>Status (activate/suspend)</li>
|
||
<li>Click <strong>"Save"</strong></li>
|
||
</ol>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Email Changes</p>
|
||
<p>Changing a user's email will require them to log in with the new email address. Notify them before making this change.</p>
|
||
</div>
|
||
<h3 id="suspending-users">Suspending Users<a class="headerlink" href="#suspending-users" title="Permanent link">¶</a></h3>
|
||
<p><strong>To temporarily disable a user account:</strong></p>
|
||
<ol>
|
||
<li>Find the user in the table</li>
|
||
<li>Click <strong>"Suspend"</strong> in the Actions column</li>
|
||
<li>Confirm suspension</li>
|
||
</ol>
|
||
<p>Suspended users:</p>
|
||
<ul>
|
||
<li>Cannot log in</li>
|
||
<li>Existing sessions are invalidated immediately</li>
|
||
<li>Can be reactivated at any time</li>
|
||
<li>Data and history are preserved</li>
|
||
</ul>
|
||
<p><strong>When to suspend:</strong></p>
|
||
<ul>
|
||
<li>Volunteer is temporarily unavailable</li>
|
||
<li>Security concerns (investigate before deleting)</li>
|
||
<li>User requests account pause</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Suspend confirmation dialog explaining effects</em></p>
|
||
<h3 id="password-resets">Password Resets<a class="headerlink" href="#password-resets" title="Permanent link">¶</a></h3>
|
||
<p><strong>To reset a user's password:</strong></p>
|
||
<ol>
|
||
<li>Edit the user</li>
|
||
<li>Click <strong>"Reset Password"</strong></li>
|
||
<li>Choose one of:</li>
|
||
<li><strong>Generate temporary password</strong> (shown on screen, expires in 24 hours)</li>
|
||
<li><strong>Send reset email</strong> (user clicks link to set new password)</li>
|
||
<li>Provide temporary password to user securely (not via email)</li>
|
||
</ol>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Security Best Practice</p>
|
||
<p>Always use "Send reset email" option when possible. Only generate temporary passwords for in-person support scenarios.</p>
|
||
</div>
|
||
<h3 id="deleting-users">Deleting Users<a class="headerlink" href="#deleting-users" title="Permanent link">¶</a></h3>
|
||
<div class="admonition danger">
|
||
<p class="admonition-title">Permanent Action</p>
|
||
<p>Deleting a user is permanent and cannot be undone. All associated data (canvass visits, responses, etc.) will be anonymized.</p>
|
||
</div>
|
||
<p><strong>To delete a user:</strong></p>
|
||
<ol>
|
||
<li>Click the <strong>Delete</strong> icon (trash) in the Actions column</li>
|
||
<li>Type the user's email to confirm</li>
|
||
<li>Click <strong>"Delete Permanently"</strong></li>
|
||
</ol>
|
||
<p><strong>When deletion is appropriate:</strong></p>
|
||
<ul>
|
||
<li>Duplicate accounts</li>
|
||
<li>Test accounts in production</li>
|
||
<li>User requests account deletion (GDPR compliance)</li>
|
||
</ul>
|
||
<p><strong>Data handling on deletion:</strong></p>
|
||
<ul>
|
||
<li>User account record is deleted</li>
|
||
<li>Associated content (responses, visits) remains but user reference is nullified</li>
|
||
<li>Email queue jobs remain (email address is preserved for audit)</li>
|
||
</ul>
|
||
<h3 id="viewing-login-activity">Viewing Login Activity<a class="headerlink" href="#viewing-login-activity" title="Permanent link">¶</a></h3>
|
||
<p><strong>To see recent login activity:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Users</strong></li>
|
||
<li>Check the <strong>"Last Login"</strong> column</li>
|
||
<li>Click on a user to see detailed login history (if audit logging is enabled)</li>
|
||
</ol>
|
||
<p><strong>Screenshot placeholder</strong>: <em>User detail view showing login history table with timestamps and IP addresses</em></p>
|
||
<hr />
|
||
<h2 id="campaign-management">Campaign Management<a class="headerlink" href="#campaign-management" title="Permanent link">¶</a></h2>
|
||
<h3 id="campaign-overview">Campaign Overview<a class="headerlink" href="#campaign-overview" title="Permanent link">¶</a></h3>
|
||
<p>Campaigns are at the heart of the Influence module. A campaign allows citizens to:</p>
|
||
<ol>
|
||
<li>Enter their postal code</li>
|
||
<li>Find their elected representatives</li>
|
||
<li>Send advocacy emails</li>
|
||
<li>Share their story on a public response wall</li>
|
||
</ol>
|
||
<p>As an administrator, you can create, configure, publish, and monitor campaigns.</p>
|
||
<h3 id="creating-a-campaign">Creating a Campaign<a class="headerlink" href="#creating-a-campaign" title="Permanent link">¶</a></h3>
|
||
<p><strong>To create a new campaign:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Influence > Campaigns</strong></li>
|
||
<li>Click <strong>"Create Campaign"</strong> (top-right)</li>
|
||
<li>Fill in the campaign form (see fields below)</li>
|
||
<li>Click <strong>"Create"</strong></li>
|
||
</ol>
|
||
<p><strong>Required fields:</strong></p>
|
||
<p><strong>Basic Information:</strong></p>
|
||
<ul>
|
||
<li><strong>Title</strong>: Campaign name (shown to public)</li>
|
||
<li>Example: "Protect Our Climate"</li>
|
||
<li><strong>Slug</strong>: URL-friendly identifier (auto-generated from title)</li>
|
||
<li>Example: <code>protect-our-climate</code></li>
|
||
<li>Used in public URL: <code>/campaigns/protect-our-climate</code></li>
|
||
<li><strong>Description</strong>: Campaign overview (supports HTML)</li>
|
||
<li>Shown on campaign listing page</li>
|
||
<li>Recommended: 2-3 sentences</li>
|
||
</ul>
|
||
<p><strong>Email Configuration:</strong></p>
|
||
<ul>
|
||
<li><strong>Email Subject</strong>: Subject line for advocacy emails</li>
|
||
<li>Example: "Please support climate action legislation"</li>
|
||
<li>Variables supported: <code>{{USER_NAME}}</code>, <code>{{REP_NAME}}</code></li>
|
||
<li><strong>Email Body</strong>: The email message citizens send</li>
|
||
<li>HTML editor available</li>
|
||
<li>Variables: <code>{{USER_NAME}}</code>, <code>{{USER_EMAIL}}</code>, <code>{{REP_NAME}}</code>, <code>{{REP_EMAIL}}</code>, <code>{{USER_MESSAGE}}</code></li>
|
||
<li>Preview before publishing</li>
|
||
</ul>
|
||
<p><strong>Targeting:</strong></p>
|
||
<ul>
|
||
<li><strong>Government Level</strong>: FEDERAL, PROVINCIAL, or MUNICIPAL</li>
|
||
<li>Determines which representatives are looked up</li>
|
||
<li>Can select multiple levels</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Create Campaign form showing title, slug, description, email subject, and body editor</em></p>
|
||
<h3 id="understanding-feature-flags">Understanding Feature Flags<a class="headerlink" href="#understanding-feature-flags" title="Permanent link">¶</a></h3>
|
||
<p>Campaigns have 12 feature flags that control functionality:</p>
|
||
<h4 id="core-features">Core Features<a class="headerlink" href="#core-features" title="Permanent link">¶</a></h4>
|
||
<ol>
|
||
<li><strong>Published</strong></li>
|
||
<li>Controls public visibility</li>
|
||
<li>Unpublished campaigns only visible to admins</li>
|
||
<li>
|
||
<p>Toggle to launch/pause campaign</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Featured</strong></p>
|
||
</li>
|
||
<li>Featured campaigns appear at top of listing page</li>
|
||
<li>Use for high-priority campaigns</li>
|
||
<li>
|
||
<p>Limit to 2-3 featured campaigns</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Has Response Wall</strong></p>
|
||
</li>
|
||
<li>Enables public response wall</li>
|
||
<li>Citizens can share their story after emailing</li>
|
||
<li>
|
||
<p>Responses require admin approval (unless <code>auto_approve_responses</code>)</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Collect Phone Numbers</strong></p>
|
||
</li>
|
||
<li>Adds optional phone number field</li>
|
||
<li>Used for call-in campaigns</li>
|
||
<li>
|
||
<p>Numbers stored for admin use</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Track Calls</strong></p>
|
||
</li>
|
||
<li>Adds "I called my representative" button</li>
|
||
<li>Tracks call attempts separately from emails</li>
|
||
<li>Good for blended campaigns</li>
|
||
</ol>
|
||
<h4 id="advanced-features">Advanced Features<a class="headerlink" href="#advanced-features" title="Permanent link">¶</a></h4>
|
||
<ol>
|
||
<li><strong>Require Verification</strong></li>
|
||
<li>Sends verification email before submitting</li>
|
||
<li>Prevents spam and bot submissions</li>
|
||
<li>
|
||
<p>Recommended for public campaigns</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Auto Approve Responses</strong></p>
|
||
</li>
|
||
<li>Response wall submissions appear immediately</li>
|
||
<li>No admin moderation required</li>
|
||
<li>
|
||
<p>Only use for trusted campaigns</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Allow Anonymous</strong></p>
|
||
</li>
|
||
<li>Citizens can submit without creating account</li>
|
||
<li>Reduces friction but limits tracking</li>
|
||
<li>
|
||
<p>Good for privacy-sensitive topics</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Custom Recipients</strong></p>
|
||
</li>
|
||
<li>Override representative lookup</li>
|
||
<li>Send to specific email addresses</li>
|
||
<li>
|
||
<p>Use for non-government campaigns</p>
|
||
</li>
|
||
<li>
|
||
<p><strong>Show Progress Bar</strong></p>
|
||
<ul>
|
||
<li>Displays email count goal and progress</li>
|
||
<li>Motivates participation</li>
|
||
<li>Requires setting <code>email_goal</code> field</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><strong>Disable After Date</strong></p>
|
||
<ul>
|
||
<li>Automatically unpublish after specified date</li>
|
||
<li>Good for time-sensitive campaigns</li>
|
||
<li>Requires setting <code>disable_date</code> field</li>
|
||
</ul>
|
||
</li>
|
||
<li>
|
||
<p><strong>Enable Comments</strong></p>
|
||
<ul>
|
||
<li>Allow comments on response wall entries</li>
|
||
<li>Creates discussion threads</li>
|
||
<li>Requires moderation</li>
|
||
</ul>
|
||
</li>
|
||
</ol>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Campaign feature flags showing toggles for all 12 flags with descriptive labels</em></p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Recommended Defaults</p>
|
||
<p>For most campaigns, enable: <strong>Published</strong>, <strong>Has Response Wall</strong>, <strong>Require Verification</strong>. Leave others off unless specifically needed.</p>
|
||
</div>
|
||
<h3 id="configuring-email-template">Configuring Email Template<a class="headerlink" href="#configuring-email-template" title="Permanent link">¶</a></h3>
|
||
<p>The email template is what citizens send to their representatives. Make it:</p>
|
||
<p><strong>Effective email guidelines:</strong></p>
|
||
<ul>
|
||
<li><strong>Personal</strong>: Use variables like <code>{{USER_NAME}}</code> to personalize</li>
|
||
<li><strong>Clear</strong>: State the ask in first paragraph</li>
|
||
<li><strong>Specific</strong>: Reference specific legislation or issue</li>
|
||
<li><strong>Respectful</strong>: Professional tone, even if issue is urgent</li>
|
||
<li><strong>Actionable</strong>: Tell representatives exactly what you want them to do</li>
|
||
</ul>
|
||
<p><strong>Example template:</strong></p>
|
||
<div class="language-text highlight"><pre><span></span><code><span id="__span-2-1"><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>Subject: Please vote YES on Bill C-123 for climate action
|
||
</span><span id="__span-2-2"><a id="__codelineno-2-2" name="__codelineno-2-2" href="#__codelineno-2-2"></a>
|
||
</span><span id="__span-2-3"><a id="__codelineno-2-3" name="__codelineno-2-3" href="#__codelineno-2-3"></a>Dear {{REP_NAME}},
|
||
</span><span id="__span-2-4"><a id="__codelineno-2-4" name="__codelineno-2-4" href="#__codelineno-2-4"></a>
|
||
</span><span id="__span-2-5"><a id="__codelineno-2-5" name="__codelineno-2-5" href="#__codelineno-2-5"></a>My name is {{USER_NAME}}, and I am a constituent in your riding. I'm writing to urge you to vote YES on Bill C-123, the Climate Action Framework.
|
||
</span><span id="__span-2-6"><a id="__codelineno-2-6" name="__codelineno-2-6" href="#__codelineno-2-6"></a>
|
||
</span><span id="__span-2-7"><a id="__codelineno-2-7" name="__codelineno-2-7" href="#__codelineno-2-7"></a>Climate change is the defining issue of our generation. This bill provides a realistic pathway to reduce emissions while protecting jobs and supporting workers.
|
||
</span><span id="__span-2-8"><a id="__codelineno-2-8" name="__codelineno-2-8" href="#__codelineno-2-8"></a>
|
||
</span><span id="__span-2-9"><a id="__codelineno-2-9" name="__codelineno-2-9" href="#__codelineno-2-9"></a>I'm specifically asking you to:
|
||
</span><span id="__span-2-10"><a id="__codelineno-2-10" name="__codelineno-2-10" href="#__codelineno-2-10"></a>1. Vote YES on Bill C-123 when it comes to the floor
|
||
</span><span id="__span-2-11"><a id="__codelineno-2-11" name="__codelineno-2-11" href="#__codelineno-2-11"></a>2. Speak publicly in support of climate action
|
||
</span><span id="__span-2-12"><a id="__codelineno-2-12" name="__codelineno-2-12" href="#__codelineno-2-12"></a>3. Oppose any amendments that weaken the bill
|
||
</span><span id="__span-2-13"><a id="__codelineno-2-13" name="__codelineno-2-13" href="#__codelineno-2-13"></a>
|
||
</span><span id="__span-2-14"><a id="__codelineno-2-14" name="__codelineno-2-14" href="#__codelineno-2-14"></a>Thank you for considering my views. I look forward to your response.
|
||
</span><span id="__span-2-15"><a id="__codelineno-2-15" name="__codelineno-2-15" href="#__codelineno-2-15"></a>
|
||
</span><span id="__span-2-16"><a id="__codelineno-2-16" name="__codelineno-2-16" href="#__codelineno-2-16"></a>Sincerely,
|
||
</span><span id="__span-2-17"><a id="__codelineno-2-17" name="__codelineno-2-17" href="#__codelineno-2-17"></a>{{USER_NAME}}
|
||
</span><span id="__span-2-18"><a id="__codelineno-2-18" name="__codelineno-2-18" href="#__codelineno-2-18"></a>{{USER_EMAIL}}
|
||
</span><span id="__span-2-19"><a id="__codelineno-2-19" name="__codelineno-2-19" href="#__codelineno-2-19"></a>
|
||
</span><span id="__span-2-20"><a id="__codelineno-2-20" name="__codelineno-2-20" href="#__codelineno-2-20"></a>---
|
||
</span><span id="__span-2-21"><a id="__codelineno-2-21" name="__codelineno-2-21" href="#__codelineno-2-21"></a>{{USER_MESSAGE}}
|
||
</span></code></pre></div>
|
||
<p><strong>Available variables:</strong></p>
|
||
<ul>
|
||
<li><code>{{USER_NAME}}</code> — Citizen's full name</li>
|
||
<li><code>{{USER_EMAIL}}</code> — Citizen's email address</li>
|
||
<li><code>{{USER_PHONE}}</code> — Citizen's phone (if collected)</li>
|
||
<li><code>{{REP_NAME}}</code> — Representative's name</li>
|
||
<li><code>{{REP_EMAIL}}</code> — Representative's email</li>
|
||
<li><code>{{REP_TITLE}}</code> — Representative's title (MP, MPP, Councillor)</li>
|
||
<li><code>{{USER_MESSAGE}}</code> — Custom message from citizen (optional field)</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Email template editor showing subject and body fields with variable insertion dropdown</em></p>
|
||
<h3 id="publishing-a-campaign">Publishing a Campaign<a class="headerlink" href="#publishing-a-campaign" title="Permanent link">¶</a></h3>
|
||
<p>Before publishing, verify:</p>
|
||
<ul class="task-list">
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Email template is proofread (send test email to yourself)</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Feature flags are configured correctly</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Representative lookup is working (test with your postal code)</li>
|
||
<li class="task-list-item"><label class="task-list-control"><input type="checkbox" disabled/><span class="task-list-indicator"></span></label> Response wall moderation is ready (if enabled)</li>
|
||
</ul>
|
||
<p><strong>To publish:</strong></p>
|
||
<ol>
|
||
<li>Edit the campaign</li>
|
||
<li>Toggle <strong>"Published"</strong> flag to ON</li>
|
||
<li>Click <strong>"Save"</strong></li>
|
||
</ol>
|
||
<p>The campaign is now live at <code>/campaigns/[slug]</code>.</p>
|
||
<p><strong>Promoting your campaign:</strong></p>
|
||
<ul>
|
||
<li>Share direct link: <code>https://yourdomain.org/campaigns/protect-our-climate</code></li>
|
||
<li>Embed in email newsletter</li>
|
||
<li>Post on social media</li>
|
||
<li>Add to landing page</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Published campaign card on public campaigns listing page</em></p>
|
||
<h3 id="monitoring-email-sends">Monitoring Email Sends<a class="headerlink" href="#monitoring-email-sends" title="Permanent link">¶</a></h3>
|
||
<p><strong>To view email statistics:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Influence > Campaigns</strong></li>
|
||
<li>Click <strong>"Emails"</strong> button in the Actions column for your campaign</li>
|
||
</ol>
|
||
<p>The <strong>Campaign Emails</strong> drawer shows:</p>
|
||
<p><strong>Statistics:</strong></p>
|
||
<ul>
|
||
<li>Total emails sent</li>
|
||
<li>Successful deliveries</li>
|
||
<li>Failed deliveries</li>
|
||
<li>Emails waiting in queue</li>
|
||
</ul>
|
||
<p><strong>Email list table:</strong></p>
|
||
<ul>
|
||
<li>Recipient name and email</li>
|
||
<li>Status (PENDING, SENT, FAILED)</li>
|
||
<li>Sent timestamp</li>
|
||
<li>Representative targeted</li>
|
||
<li>Error message (if failed)</li>
|
||
</ul>
|
||
<p><strong>Actions:</strong></p>
|
||
<ul>
|
||
<li><strong>Retry failed</strong>: Re-queue failed emails</li>
|
||
<li><strong>Export CSV</strong>: Download full email list</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Campaign Emails drawer showing statistics cards and email list table</em></p>
|
||
<h3 id="managing-the-email-queue">Managing the Email Queue<a class="headerlink" href="#managing-the-email-queue" title="Permanent link">¶</a></h3>
|
||
<p>The email queue processes advocacy emails asynchronously using BullMQ.</p>
|
||
<p><strong>To monitor queue health:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Influence > Email Queue</strong></li>
|
||
</ol>
|
||
<p><strong>Queue statistics:</strong></p>
|
||
<ul>
|
||
<li><strong>Waiting</strong>: Emails queued but not yet processing</li>
|
||
<li><strong>Active</strong>: Emails currently being sent</li>
|
||
<li><strong>Completed</strong>: Successfully sent emails (last 24 hours)</li>
|
||
<li><strong>Failed</strong>: Failed emails requiring retry</li>
|
||
<li><strong>Delayed</strong>: Scheduled for future sending</li>
|
||
</ul>
|
||
<p><strong>Queue controls:</strong></p>
|
||
<ul>
|
||
<li><strong>Pause Queue</strong>: Stop processing new emails (emergencies only)</li>
|
||
<li><strong>Resume Queue</strong>: Restart after pause</li>
|
||
<li><strong>Clean Completed</strong>: Remove old completed jobs (frees memory)</li>
|
||
<li><strong>Retry Failed</strong>: Re-queue all failed emails</li>
|
||
</ul>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Queue Pausing</p>
|
||
<p>Only pause the queue during system maintenance or if email configuration is broken. Citizens expect immediate sends.</p>
|
||
</div>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Email Queue page showing statistics cards, job counts, and control buttons</em></p>
|
||
<h3 id="moderating-responses">Moderating Responses<a class="headerlink" href="#moderating-responses" title="Permanent link">¶</a></h3>
|
||
<p>If your campaign has <strong>"Has Response Wall"</strong> enabled, citizens can share their stories publicly.</p>
|
||
<p><strong>To moderate responses:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Influence > Responses</strong></li>
|
||
<li>Use filters to find pending responses</li>
|
||
<li>Review each response</li>
|
||
<li>Approve or reject</li>
|
||
</ol>
|
||
<p><strong>Response filters:</strong></p>
|
||
<ul>
|
||
<li><strong>Campaign</strong>: Filter by specific campaign</li>
|
||
<li><strong>Status</strong>: PENDING, APPROVED, REJECTED</li>
|
||
<li><strong>Search</strong>: Search response text</li>
|
||
<li><strong>Date range</strong>: Filter by submission date</li>
|
||
</ul>
|
||
<p><strong>Response table columns:</strong></p>
|
||
<ul>
|
||
<li><strong>Name</strong>: Citizen's name</li>
|
||
<li><strong>Campaign</strong>: Which campaign</li>
|
||
<li><strong>Status</strong>: Approval status (color-coded)</li>
|
||
<li><strong>Upvotes</strong>: Number of upvotes received</li>
|
||
<li><strong>Submitted</strong>: Submission date</li>
|
||
<li><strong>Actions</strong>: View, approve, reject, delete</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Responses table with filter controls and status badges</em></p>
|
||
<p><strong>To review a response:</strong></p>
|
||
<ol>
|
||
<li>Click <strong>"View"</strong> in Actions column</li>
|
||
<li>Read full response text</li>
|
||
<li>Decide:</li>
|
||
<li><strong>Approve</strong>: Make public (appears on response wall)</li>
|
||
<li><strong>Reject</strong>: Hide from public (not deleted)</li>
|
||
<li><strong>Delete</strong>: Permanently remove</li>
|
||
</ol>
|
||
<p><strong>Moderation guidelines:</strong></p>
|
||
<p><strong>Approve responses that:</strong></p>
|
||
<ul>
|
||
<li>Are authentic personal stories</li>
|
||
<li>Relate to the campaign issue</li>
|
||
<li>Use respectful language</li>
|
||
<li>Add value to the public conversation</li>
|
||
</ul>
|
||
<p><strong>Reject responses that:</strong></p>
|
||
<ul>
|
||
<li>Contain profanity or hate speech</li>
|
||
<li>Are spam or off-topic</li>
|
||
<li>Violate privacy (include private information about others)</li>
|
||
<li>Are duplicate submissions</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Response detail modal showing full text, citizen info, and approve/reject buttons</em></p>
|
||
<hr />
|
||
<h2 id="location-management">Location Management<a class="headerlink" href="#location-management" title="Permanent link">¶</a></h2>
|
||
<h3 id="location-data-overview">Location Data Overview<a class="headerlink" href="#location-data-overview" title="Permanent link">¶</a></h3>
|
||
<p>Locations represent physical addresses where canvassing occurs. Each location has:</p>
|
||
<ul>
|
||
<li><strong>Address</strong>: Street address, city, province, postal code</li>
|
||
<li><strong>Coordinates</strong>: Latitude/longitude (from geocoding)</li>
|
||
<li><strong>Metadata</strong>: Building type, federal district, unit count</li>
|
||
<li><strong>Cut assignment</strong>: Which territorial cut it belongs to</li>
|
||
<li><strong>Canvass history</strong>: Visits, outcomes, support levels</li>
|
||
</ul>
|
||
<h3 id="importing-locations-from-csv">Importing Locations from CSV<a class="headerlink" href="#importing-locations-from-csv" title="Permanent link">¶</a></h3>
|
||
<p><strong>To import locations:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Click <strong>"Import CSV"</strong> button</li>
|
||
<li>Upload CSV file</li>
|
||
<li>Map CSV columns to location fields</li>
|
||
<li>Click <strong>"Import"</strong></li>
|
||
</ol>
|
||
<p><strong>Required CSV columns:</strong></p>
|
||
<ul>
|
||
<li><strong>address</strong> — Full street address</li>
|
||
<li><strong>city</strong> — City name</li>
|
||
<li><strong>province</strong> — Province/state code (e.g., "ON", "BC")</li>
|
||
<li><strong>postalCode</strong> — Postal code (e.g., "K1A 0B1")</li>
|
||
</ul>
|
||
<p><strong>Optional columns:</strong></p>
|
||
<ul>
|
||
<li><strong>latitude</strong> — Pre-geocoded latitude</li>
|
||
<li><strong>longitude</strong> — Pre-geocoded longitude</li>
|
||
<li><strong>buildingType</strong> — RESIDENTIAL, APARTMENT, BUSINESS</li>
|
||
<li><strong>unitCount</strong> — Number of units in building</li>
|
||
<li><strong>federalDistrict</strong> — Electoral district</li>
|
||
<li><strong>notes</strong> — Internal notes</li>
|
||
</ul>
|
||
<p><strong>CSV example:</strong></p>
|
||
<div class="language-text highlight"><pre><span></span><code><span id="__span-3-1"><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>address,city,province,postalCode,buildingType
|
||
</span><span id="__span-3-2"><a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a>"123 Main St","Ottawa","ON","K1A 0B1","RESIDENTIAL"
|
||
</span><span id="__span-3-3"><a id="__codelineno-3-3" name="__codelineno-3-3" href="#__codelineno-3-3"></a>"456 Queen St E","Toronto","ON","M5A 1T1","APARTMENT"
|
||
</span><span id="__span-3-4"><a id="__codelineno-3-4" name="__codelineno-3-4" href="#__codelineno-3-4"></a>"789 Granville St","Vancouver","BC","V6Z 1K3","BUSINESS"
|
||
</span></code></pre></div>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Excel to CSV</p>
|
||
<p>If your data is in Excel, use "Save As" > "CSV (Comma delimited)" to export.</p>
|
||
</div>
|
||
<p><strong>Screenshot placeholder</strong>: <em>CSV import dialog showing file upload, column mapping interface, and preview table</em></p>
|
||
<h3 id="nar-import-canadian-electoral-data">NAR Import (Canadian Electoral Data)<a class="headerlink" href="#nar-import-canadian-electoral-data" title="Permanent link">¶</a></h3>
|
||
<p>For Canadian campaigns, you can import official electoral data from Elections Canada NAR (National Address Register) files.</p>
|
||
<p><strong>To import NAR data:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Click <strong>"NAR Import"</strong> button</li>
|
||
<li>Select province</li>
|
||
<li>Choose NAR dataset (year)</li>
|
||
<li>Apply filters:</li>
|
||
<li>City filter (optional)</li>
|
||
<li>Postal code filter (optional)</li>
|
||
<li>Cut filter (assign to specific cut)</li>
|
||
<li>Residential only (exclude commercial)</li>
|
||
<li>Click <strong>"Start Import"</strong></li>
|
||
</ol>
|
||
<p>The import runs server-side and can take several minutes for large provinces.</p>
|
||
<p><strong>NAR data includes:</strong></p>
|
||
<ul>
|
||
<li>Precise civic addresses (from Address files)</li>
|
||
<li>Geocoded coordinates (from Location files)</li>
|
||
<li>Federal electoral districts</li>
|
||
<li>Building use (residential, commercial, institutional)</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>NAR Import modal showing province selector, dataset picker, and filter options</em></p>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">NAR Data Source</p>
|
||
<p>NAR data must be obtained from Elections Canada and placed in the <code>/data</code> directory on the server. Contact your system administrator.</p>
|
||
</div>
|
||
<h3 id="geocoding-addresses">Geocoding Addresses<a class="headerlink" href="#geocoding-addresses" title="Permanent link">¶</a></h3>
|
||
<p>Geocoding converts addresses to latitude/longitude coordinates for map display.</p>
|
||
<p><strong>Automatic geocoding:</strong></p>
|
||
<ul>
|
||
<li>CSV imports without lat/lng are automatically geocoded</li>
|
||
<li>NAR imports include pre-geocoded coordinates</li>
|
||
<li>Manual location creation triggers geocoding</li>
|
||
</ul>
|
||
<p><strong>Manual geocoding:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Filter for <strong>"Ungeocoded"</strong> locations</li>
|
||
<li>Select locations to geocode</li>
|
||
<li>Click <strong>"Geocode Selected"</strong> (bulk action)</li>
|
||
</ol>
|
||
<p><strong>Geocoding providers</strong> (tried in order):</p>
|
||
<ol>
|
||
<li><strong>Nominatim</strong> (OpenStreetMap) — Free, no API key required</li>
|
||
<li><strong>ArcGIS</strong> — Free tier, accurate for North America</li>
|
||
<li><strong>Photon</strong> — Free, Europe-focused</li>
|
||
<li><strong>Mapbox</strong> — Requires API key, very accurate</li>
|
||
<li><strong>Google</strong> — Requires API key, most accurate</li>
|
||
<li><strong>LocationIQ</strong> — Requires API key, Nominatim-based</li>
|
||
</ol>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Geocoding Quality</p>
|
||
<p>Check <strong>Map > Data Quality</strong> to review geocoding confidence levels. Re-geocode low-confidence addresses.</p>
|
||
</div>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Locations table with "Geocode Selected" button and geocoding status column</em></p>
|
||
<h3 id="creating-cuts">Creating Cuts<a class="headerlink" href="#creating-cuts" title="Permanent link">¶</a></h3>
|
||
<p>Cuts are geographic areas (wards, neighborhoods, districts) used to organize canvassing.</p>
|
||
<p><strong>To create a cut:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Cuts</strong></li>
|
||
<li>Click the <strong>"Map Drawing"</strong> tab</li>
|
||
<li>Click <strong>"Start Drawing"</strong></li>
|
||
<li>Click on the map to add polygon vertices</li>
|
||
<li>Close the polygon (click near first point)</li>
|
||
<li>Fill in cut details:</li>
|
||
<li><strong>Name</strong>: Cut identifier (e.g., "Ward 5", "Downtown")</li>
|
||
<li><strong>Category</strong>: WARD, NEIGHBORHOOD, DISTRICT, or CUSTOM</li>
|
||
<li><strong>Color</strong>: Display color on map</li>
|
||
<li><strong>Description</strong>: Internal notes</li>
|
||
<li>Click <strong>"Save Cut"</strong></li>
|
||
</ol>
|
||
<p><strong>Cut best practices:</strong></p>
|
||
<ul>
|
||
<li><strong>Size</strong>: 200-500 locations per cut (manageable for canvassing)</li>
|
||
<li><strong>Boundaries</strong>: Use natural boundaries (roads, rivers, parks)</li>
|
||
<li><strong>Naming</strong>: Use official ward/district names when available</li>
|
||
<li><strong>Colors</strong>: Use distinct colors for adjacent cuts</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Cut drawing map interface showing polygon being drawn with vertex markers</em></p>
|
||
<h3 id="assigning-locations-to-cuts">Assigning Locations to Cuts<a class="headerlink" href="#assigning-locations-to-cuts" title="Permanent link">¶</a></h3>
|
||
<p><strong>Automatic assignment</strong> (during cut creation):</p>
|
||
<ul>
|
||
<li>Locations inside polygon are automatically assigned</li>
|
||
<li>Uses point-in-polygon algorithm</li>
|
||
</ul>
|
||
<p><strong>Manual assignment:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Select locations to assign</li>
|
||
<li>Choose <strong>"Assign to Cut"</strong> from bulk actions</li>
|
||
<li>Select target cut</li>
|
||
<li>Click <strong>"Assign"</strong></li>
|
||
</ol>
|
||
<p><strong>Viewing cut assignments:</strong></p>
|
||
<ul>
|
||
<li>Location table has <strong>"Cut"</strong> column</li>
|
||
<li>Filter locations by cut using dropdown</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Bulk action modal showing "Assign to Cut" with cut selector dropdown</em></p>
|
||
<h3 id="managing-locations">Managing Locations<a class="headerlink" href="#managing-locations" title="Permanent link">¶</a></h3>
|
||
<p><strong>To edit a location:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Click <strong>"Edit"</strong> in Actions column</li>
|
||
<li>Modify fields:</li>
|
||
<li>Address details</li>
|
||
<li>Coordinates (manually adjust map pin)</li>
|
||
<li>Building type</li>
|
||
<li>Unit count</li>
|
||
<li>Notes</li>
|
||
<li>Cut assignment</li>
|
||
<li>Click <strong>"Save"</strong></li>
|
||
</ol>
|
||
<p><strong>To delete locations:</strong></p>
|
||
<ol>
|
||
<li>Select locations in table</li>
|
||
<li>Choose <strong>"Delete"</strong> from bulk actions</li>
|
||
<li>Confirm deletion</li>
|
||
</ol>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Canvass History</p>
|
||
<p>Deleting a location preserves associated canvass visits (visits are linked to coordinates, not location records).</p>
|
||
</div>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Edit Location modal showing address fields, map with draggable pin, and metadata fields</em></p>
|
||
<h3 id="exporting-walk-sheets">Exporting Walk Sheets<a class="headerlink" href="#exporting-walk-sheets" title="Permanent link">¶</a></h3>
|
||
<p>Walk sheets are printable lists of addresses for door-to-door canvassing.</p>
|
||
<p><strong>To generate a walk sheet:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Filter to specific cut</li>
|
||
<li>Click <strong>"Walk Sheet"</strong> in the cut's action menu</li>
|
||
</ol>
|
||
<p>OR:</p>
|
||
<ol>
|
||
<li>Navigate to <strong>Canvass > Walk Sheet</strong></li>
|
||
<li>Select cut from dropdown</li>
|
||
<li>Configure settings (see below)</li>
|
||
<li>Click <strong>"Print"</strong></li>
|
||
</ol>
|
||
<p><strong>Walk sheet settings</strong> (from Map > Map Settings):</p>
|
||
<ul>
|
||
<li><strong>Header text</strong>: Organization name, campaign info</li>
|
||
<li><strong>Instructions</strong>: How to use the walk sheet</li>
|
||
<li><strong>QR code</strong>: Include QR code linking to volunteer canvass map</li>
|
||
<li><strong>Sorting</strong>: Sort by street name or walking route</li>
|
||
<li><strong>Include map</strong>: Embed cut map on first page</li>
|
||
</ul>
|
||
<p><strong>Walk sheet contents:</strong></p>
|
||
<ul>
|
||
<li>Cut name and statistics</li>
|
||
<li>QR code (volunteers scan to start canvass session)</li>
|
||
<li>Location table:</li>
|
||
<li>Address</li>
|
||
<li>Unit count</li>
|
||
<li>Last visit date</li>
|
||
<li>Last outcome</li>
|
||
<li>Notes field (blank for volunteers to fill)</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Walk sheet PDF preview showing header, QR code, and address table</em></p>
|
||
<hr />
|
||
<h2 id="volunteer-management">Volunteer Management<a class="headerlink" href="#volunteer-management" title="Permanent link">¶</a></h2>
|
||
<h3 id="creating-shifts">Creating Shifts<a class="headerlink" href="#creating-shifts" title="Permanent link">¶</a></h3>
|
||
<p>Shifts are scheduled volunteer canvassing sessions assigned to specific cuts.</p>
|
||
<p><strong>To create a shift:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Shifts</strong></li>
|
||
<li>Click <strong>"Create Shift"</strong></li>
|
||
<li>Fill in shift details:</li>
|
||
<li><strong>Title</strong>: Shift name (e.g., "Saturday Morning Canvass - Ward 5")</li>
|
||
<li><strong>Description</strong>: Additional details for volunteers</li>
|
||
<li><strong>Start Time</strong>: Shift start date and time</li>
|
||
<li><strong>End Time</strong>: Shift end date and time</li>
|
||
<li><strong>Cut</strong>: Which cut to canvass (optional, but recommended)</li>
|
||
<li><strong>Max Signups</strong>: Capacity limit (0 = unlimited)</li>
|
||
<li><strong>Meeting Location</strong>: Where volunteers should meet</li>
|
||
<li>Click <strong>"Create"</strong></li>
|
||
</ol>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Create Shift modal showing date/time picker, cut selector, and capacity field</em></p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Cut Assignment</p>
|
||
<p>Shifts assigned to a cut appear in the volunteer portal under "My Assignments" for volunteers who signed up. Volunteers can start canvassing directly from their dashboard.</p>
|
||
</div>
|
||
<h3 id="managing-shift-signups">Managing Shift Signups<a class="headerlink" href="#managing-shift-signups" title="Permanent link">¶</a></h3>
|
||
<p><strong>To view shift signups:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Shifts</strong></li>
|
||
<li>Click <strong>"Signups"</strong> in Actions column</li>
|
||
</ol>
|
||
<p>The signups drawer shows:</p>
|
||
<ul>
|
||
<li><strong>Total signups</strong> vs capacity</li>
|
||
<li><strong>Signup list</strong>: Name, email, role, signup date</li>
|
||
<li><strong>Actions</strong>: Remove signup, upgrade TEMP users to USER</li>
|
||
</ul>
|
||
<p><strong>Signup sources:</strong></p>
|
||
<ul>
|
||
<li><strong>Public signup form</strong>: <code>/shifts</code> page (creates TEMP users)</li>
|
||
<li><strong>Admin-created</strong>: You manually add volunteers</li>
|
||
<li><strong>Volunteer portal</strong>: USER-role volunteers sign up themselves</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Shift Signups drawer showing capacity gauge and signup list table</em></p>
|
||
<h3 id="emailing-shift-volunteers">Emailing Shift Volunteers<a class="headerlink" href="#emailing-shift-volunteers" title="Permanent link">¶</a></h3>
|
||
<p><strong>To email all volunteers in a shift:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Shifts</strong></li>
|
||
<li>Click <strong>"Signups"</strong> for the shift</li>
|
||
<li>Click <strong>"Email All"</strong> button</li>
|
||
<li>Compose email:</li>
|
||
<li><strong>Subject</strong>: Email subject line</li>
|
||
<li><strong>Body</strong>: Message (supports HTML)</li>
|
||
<li><strong>Variables</strong>: Use <code>{{NAME}}</code>, <code>{{SHIFT_TITLE}}</code>, <code>{{SHIFT_START}}</code></li>
|
||
<li>Click <strong>"Send"</strong></li>
|
||
</ol>
|
||
<p><strong>Common email scenarios:</strong></p>
|
||
<ul>
|
||
<li><strong>Reminder</strong>: Day before shift</li>
|
||
<li><strong>Cancellation</strong>: Weather or other issues</li>
|
||
<li><strong>Location change</strong>: Meeting point updated</li>
|
||
<li><strong>Follow-up</strong>: Thank you after shift</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Email Volunteers modal showing subject, body editor, and variable insertion buttons</em></p>
|
||
<h3 id="monitoring-canvass-sessions">Monitoring Canvass Sessions<a class="headerlink" href="#monitoring-canvass-sessions" title="Permanent link">¶</a></h3>
|
||
<p><strong>To view active canvass sessions:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Canvass > Dashboard</strong></li>
|
||
</ol>
|
||
<p>The dashboard shows:</p>
|
||
<p><strong>Statistics cards:</strong></p>
|
||
<ul>
|
||
<li><strong>Active sessions</strong>: Currently in progress</li>
|
||
<li><strong>Total visits today</strong>: Doors knocked</li>
|
||
<li><strong>Completed sessions</strong>: Finished today</li>
|
||
<li><strong>Average session duration</strong></li>
|
||
</ul>
|
||
<p><strong>Activity feed:</strong></p>
|
||
<ul>
|
||
<li>Real-time visit stream</li>
|
||
<li>Shows: Volunteer name, address, outcome, timestamp</li>
|
||
<li>Updates every 30 seconds</li>
|
||
</ul>
|
||
<p><strong>Cut progress table:</strong></p>
|
||
<ul>
|
||
<li>Progress by cut (% of locations visited)</li>
|
||
<li>Session count per cut</li>
|
||
<li>Visit count per cut</li>
|
||
</ul>
|
||
<p><strong>Leaderboard:</strong></p>
|
||
<ul>
|
||
<li>Top volunteers by visit count</li>
|
||
<li>Session count</li>
|
||
<li>Success rate (SPOKE_WITH outcomes)</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Canvass Dashboard showing stats cards, activity feed, and leaderboard</em></p>
|
||
<h3 id="viewing-canvass-activity-reports">Viewing Canvass Activity Reports<a class="headerlink" href="#viewing-canvass-activity-reports" title="Permanent link">¶</a></h3>
|
||
<p><strong>To see detailed canvassing data:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Canvass > Dashboard</strong></li>
|
||
<li>Use filters:</li>
|
||
<li><strong>Date range</strong>: Last 7 days, last 30 days, custom</li>
|
||
<li><strong>Cut</strong>: Specific cut or all</li>
|
||
<li><strong>Volunteer</strong>: Specific volunteer or all</li>
|
||
<li><strong>Outcome</strong>: Filter by visit outcome</li>
|
||
</ol>
|
||
<p><strong>Exportable reports:</strong></p>
|
||
<ul>
|
||
<li><strong>Visit history CSV</strong>: All visits with outcomes, notes, timestamps</li>
|
||
<li><strong>Support levels CSV</strong>: LEVEL_1 through LEVEL_4 breakdown</li>
|
||
<li><strong>Session summary CSV</strong>: Session duration, visit count, volunteer info</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Activity report filters and export buttons</em></p>
|
||
<hr />
|
||
<h2 id="site-configuration">Site Configuration<a class="headerlink" href="#site-configuration" title="Permanent link">¶</a></h2>
|
||
<h3 id="site-settings">Site Settings<a class="headerlink" href="#site-settings" title="Permanent link">¶</a></h3>
|
||
<p><strong>To configure global site settings:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Settings</strong> (gear icon in sidebar)</li>
|
||
</ol>
|
||
<p><strong>Available settings:</strong></p>
|
||
<p><strong>Branding:</strong></p>
|
||
<ul>
|
||
<li><strong>Site Name</strong>: Your organization name</li>
|
||
<li><strong>Site URL</strong>: Public website URL</li>
|
||
<li><strong>Logo URL</strong>: URL to your logo image</li>
|
||
<li><strong>Primary Color</strong>: Brand color (hex code)</li>
|
||
<li><strong>Secondary Color</strong>: Accent color</li>
|
||
</ul>
|
||
<p><strong>Email Configuration:</strong></p>
|
||
<ul>
|
||
<li><strong>From Name</strong>: Sender name for system emails</li>
|
||
<li><strong>From Email</strong>: Sender email address</li>
|
||
<li><strong>SMTP Host</strong>: Email server hostname</li>
|
||
<li><strong>SMTP Port</strong>: Usually 587 (TLS) or 465 (SSL)</li>
|
||
<li><strong>SMTP Username</strong>: SMTP authentication username</li>
|
||
<li><strong>SMTP Password</strong>: SMTP authentication password</li>
|
||
<li><strong>Test Mode</strong>: Send to MailHog instead of real SMTP (dev only)</li>
|
||
</ul>
|
||
<p><strong>Representative API:</strong></p>
|
||
<ul>
|
||
<li><strong>Represent API Base URL</strong>: Usually <code>https://represent.opennorth.ca</code></li>
|
||
<li><strong>API Key</strong>: If required by provider</li>
|
||
<li><strong>Cache TTL</strong>: How long to cache representative data (hours)</li>
|
||
</ul>
|
||
<p><strong>Feature Toggles:</strong></p>
|
||
<ul>
|
||
<li><strong>Enable Media Features</strong>: Enable video library and media management</li>
|
||
<li><strong>Enable Listmonk Sync</strong>: Sync contacts to Listmonk newsletter platform</li>
|
||
<li><strong>Allow Public Shift Signup</strong>: Anyone can sign up for shifts (creates TEMP users)</li>
|
||
<li><strong>Require Email Verification</strong>: Campaign responses require email confirmation</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Settings page showing branding, email, and feature toggle sections</em></p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Test Email Configuration</p>
|
||
<p>After changing SMTP settings, click "Send Test Email" to verify configuration before publishing campaigns.</p>
|
||
</div>
|
||
<h3 id="map-settings">Map Settings<a class="headerlink" href="#map-settings" title="Permanent link">¶</a></h3>
|
||
<p><strong>To configure map defaults:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Map Settings</strong></li>
|
||
</ol>
|
||
<p><strong>Map Configuration:</strong></p>
|
||
<ul>
|
||
<li><strong>Default Center</strong>: Latitude/longitude for map center</li>
|
||
<li>Used on public map and admin map</li>
|
||
<li>Usually your city center</li>
|
||
<li><strong>Default Zoom</strong>: Zoom level (1-18)</li>
|
||
<li>12 = city-wide view</li>
|
||
<li>15 = neighborhood view</li>
|
||
<li><strong>Enable Fullscreen</strong>: Allow fullscreen button on public map</li>
|
||
<li><strong>Enable Geolocation</strong>: Allow "Find My Location" button</li>
|
||
</ul>
|
||
<p><strong>Walk Sheet Configuration:</strong></p>
|
||
<ul>
|
||
<li><strong>Header Text</strong>: Appears at top of walk sheets</li>
|
||
<li><strong>Footer Text</strong>: Appears at bottom</li>
|
||
<li><strong>Include QR Code</strong>: Add QR code linking to volunteer map</li>
|
||
<li><strong>QR Code Size</strong>: Small, medium, or large</li>
|
||
<li><strong>Instructions</strong>: Text explaining how to use walk sheet</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Map Settings page showing map center picker and walk sheet config</em></p>
|
||
<h3 id="feature-toggles">Feature Toggles<a class="headerlink" href="#feature-toggles" title="Permanent link">¶</a></h3>
|
||
<p>Feature toggles allow you to enable/disable major platform features without code changes.</p>
|
||
<p><strong>To manage feature toggles:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Settings</strong></li>
|
||
<li>Scroll to <strong>Feature Toggles</strong> section</li>
|
||
<li>Toggle features on/off</li>
|
||
<li>Click <strong>"Save"</strong></li>
|
||
</ol>
|
||
<p><strong>Available toggles:</strong></p>
|
||
<p><strong>ENABLE_MEDIA_FEATURES</strong></p>
|
||
<ul>
|
||
<li>Enables Media Library and video management</li>
|
||
<li>Shows Media menu in sidebar</li>
|
||
<li>Allows video uploads and public media gallery</li>
|
||
<li>Requires media-api service running</li>
|
||
</ul>
|
||
<p><strong>ENABLE_LISTMONK_SYNC</strong></p>
|
||
<ul>
|
||
<li>Enables newsletter integration</li>
|
||
<li>Syncs campaign participants to Listmonk lists</li>
|
||
<li>Shows Listmonk menu in sidebar</li>
|
||
<li>Requires Listmonk service configured</li>
|
||
</ul>
|
||
<p><strong>ALLOW_PUBLIC_SHIFT_SIGNUP</strong></p>
|
||
<ul>
|
||
<li>Public can sign up for shifts at <code>/shifts</code></li>
|
||
<li>Creates TEMP user accounts automatically</li>
|
||
<li>Shows shifts on public pages</li>
|
||
<li>Disable for invitation-only volunteering</li>
|
||
</ul>
|
||
<p><strong>REQUIRE_EMAIL_VERIFICATION</strong></p>
|
||
<ul>
|
||
<li>Campaign responses require email verification</li>
|
||
<li>Prevents spam and fake submissions</li>
|
||
<li>Sends verification link before recording response</li>
|
||
<li>Recommended for public campaigns</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Feature Toggles section showing four toggles with descriptions</em></p>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Media Features</p>
|
||
<p>Enabling media features requires the <code>media-api</code> Docker container to be running. Check with your system administrator.</p>
|
||
</div>
|
||
<hr />
|
||
<h2 id="email-templates">Email Templates<a class="headerlink" href="#email-templates" title="Permanent link">¶</a></h2>
|
||
<h3 id="understanding-email-templates">Understanding Email Templates<a class="headerlink" href="#understanding-email-templates" title="Permanent link">¶</a></h3>
|
||
<p>Changemaker Lite uses email templates for system-generated emails:</p>
|
||
<p><strong>System templates:</strong></p>
|
||
<ul>
|
||
<li><strong>Welcome Email</strong>: Sent to new users</li>
|
||
<li><strong>Password Reset</strong>: Sent when user requests password reset</li>
|
||
<li><strong>Shift Confirmation</strong>: Sent when volunteer signs up for shift</li>
|
||
<li><strong>Shift Reminder</strong>: Sent day before shift</li>
|
||
<li><strong>Response Verification</strong>: Sent to verify campaign response</li>
|
||
</ul>
|
||
<p><strong>Custom templates:</strong></p>
|
||
<ul>
|
||
<li>You can create custom templates for specific needs</li>
|
||
<li>Use in shift emails, campaign follow-ups, etc.</li>
|
||
</ul>
|
||
<h3 id="editing-templates">Editing Templates<a class="headerlink" href="#editing-templates" title="Permanent link">¶</a></h3>
|
||
<p><strong>To edit an email template:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Content > Email Templates</strong></li>
|
||
<li>Click <strong>"Edit"</strong> for the template</li>
|
||
<li>Modify:</li>
|
||
<li><strong>Subject</strong>: Email subject line</li>
|
||
<li><strong>HTML Body</strong>: Rich email content</li>
|
||
<li><strong>Plain Text Body</strong>: Fallback for text-only clients</li>
|
||
<li>Use variables (e.g., <code>{{USER_NAME}}</code>, <code>{{SHIFT_TITLE}}</code>)</li>
|
||
<li>Click <strong>"Preview"</strong> to see rendered email</li>
|
||
<li>Click <strong>"Save"</strong></li>
|
||
</ol>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Email Template Editor showing subject field, HTML editor, and variable buttons</em></p>
|
||
<h3 id="available-variables">Available Variables<a class="headerlink" href="#available-variables" title="Permanent link">¶</a></h3>
|
||
<p>Templates support variable interpolation:</p>
|
||
<p><strong>User variables:</strong></p>
|
||
<ul>
|
||
<li><code>{{USER_NAME}}</code> — User's full name</li>
|
||
<li><code>{{USER_EMAIL}}</code> — User's email address</li>
|
||
</ul>
|
||
<p><strong>Shift variables:</strong></p>
|
||
<ul>
|
||
<li><code>{{SHIFT_TITLE}}</code> — Shift name</li>
|
||
<li><code>{{SHIFT_START}}</code> — Start date/time</li>
|
||
<li><code>{{SHIFT_END}}</code> — End date/time</li>
|
||
<li><code>{{SHIFT_LOCATION}}</code> — Meeting location</li>
|
||
<li><code>{{SHIFT_CUT}}</code> — Cut name</li>
|
||
</ul>
|
||
<p><strong>Campaign variables:</strong></p>
|
||
<ul>
|
||
<li><code>{{CAMPAIGN_TITLE}}</code> — Campaign name</li>
|
||
<li><code>{{CAMPAIGN_URL}}</code> — Link to campaign page</li>
|
||
</ul>
|
||
<p><strong>System variables:</strong></p>
|
||
<ul>
|
||
<li><code>{{SITE_NAME}}</code> — Your organization name</li>
|
||
<li><code>{{SITE_URL}}</code> — Website URL</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Variable reference table in template editor sidebar</em></p>
|
||
<h3 id="testing-templates">Testing Templates<a class="headerlink" href="#testing-templates" title="Permanent link">¶</a></h3>
|
||
<p><strong>To test an email template:</strong></p>
|
||
<ol>
|
||
<li>Edit the template</li>
|
||
<li>Click <strong>"Send Test Email"</strong></li>
|
||
<li>Enter your email address</li>
|
||
<li>Click <strong>"Send"</strong></li>
|
||
</ol>
|
||
<p>You'll receive the email with sample data filled in for variables.</p>
|
||
<div class="admonition tip">
|
||
<p class="admonition-title">Always Test</p>
|
||
<p>Test templates before using them in production. Check both HTML and plain text versions.</p>
|
||
</div>
|
||
<hr />
|
||
<h2 id="media-library">Media Library<a class="headerlink" href="#media-library" title="Permanent link">¶</a></h2>
|
||
<div class="admonition note">
|
||
<p class="admonition-title">Optional Feature</p>
|
||
<p>Media features must be enabled via <strong>Settings > Feature Toggles > ENABLE_MEDIA_FEATURES</strong>. Requires media-api service.</p>
|
||
</div>
|
||
<h3 id="uploading-videos">Uploading Videos<a class="headerlink" href="#uploading-videos" title="Permanent link">¶</a></h3>
|
||
<p><strong>To upload a video:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Content > Media > Library</strong></li>
|
||
<li>Click <strong>"Upload Video"</strong></li>
|
||
<li>Either:</li>
|
||
<li>Drag and drop video file</li>
|
||
<li>Click to browse and select file</li>
|
||
<li>Fill in metadata:</li>
|
||
<li><strong>Title</strong>: Video title</li>
|
||
<li><strong>Description</strong>: Video description</li>
|
||
<li><strong>Producer</strong>: Organization or creator</li>
|
||
<li><strong>Creator</strong>: Individual creator/director</li>
|
||
<li><strong>Tags</strong>: Comma-separated tags</li>
|
||
<li><strong>Directory</strong>: Organize into folders</li>
|
||
<li>Click <strong>"Upload"</strong></li>
|
||
</ol>
|
||
<p><strong>Supported formats:</strong></p>
|
||
<ul>
|
||
<li>MP4 (recommended)</li>
|
||
<li>MOV</li>
|
||
<li>AVI</li>
|
||
<li>MKV</li>
|
||
<li>WebM</li>
|
||
<li>M4V</li>
|
||
<li>FLV</li>
|
||
</ul>
|
||
<p><strong>File size limit:</strong> 10 GB per file</p>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Upload Video modal showing drag-drop area, metadata form, and progress bar</em></p>
|
||
<h3 id="automatic-metadata-extraction">Automatic Metadata Extraction<a class="headerlink" href="#automatic-metadata-extraction" title="Permanent link">¶</a></h3>
|
||
<p>When you upload a video, the system automatically extracts:</p>
|
||
<ul>
|
||
<li><strong>Duration</strong>: Length in seconds</li>
|
||
<li><strong>Dimensions</strong>: Width x height in pixels</li>
|
||
<li><strong>Orientation</strong>: PORTRAIT, LANDSCAPE, or SQUARE</li>
|
||
<li><strong>Quality</strong>: SD, HD, FULL_HD, or 4K</li>
|
||
<li><strong>Has Audio</strong>: Boolean</li>
|
||
<li><strong>File Size</strong>: Bytes</li>
|
||
</ul>
|
||
<p>This metadata is used for filtering and organizing videos.</p>
|
||
<h3 id="organizing-the-library">Organizing the Library<a class="headerlink" href="#organizing-the-library" title="Permanent link">¶</a></h3>
|
||
<p><strong>Directory structure:</strong></p>
|
||
<ul>
|
||
<li>Create directories to organize videos</li>
|
||
<li>Directories are simple text paths (e.g., "events/2024", "testimonials")</li>
|
||
<li>Set directory when uploading or editing</li>
|
||
</ul>
|
||
<p><strong>Filtering videos:</strong></p>
|
||
<ul>
|
||
<li><strong>Search</strong>: Search title, description, tags</li>
|
||
<li><strong>Directory</strong>: Filter by directory</li>
|
||
<li><strong>Quality</strong>: Filter by SD, HD, etc.</li>
|
||
<li><strong>Orientation</strong>: Portrait, landscape, square</li>
|
||
<li><strong>Locked</strong>: Show only locked or unlocked</li>
|
||
</ul>
|
||
<p><strong>Sorting:</strong></p>
|
||
<ul>
|
||
<li>Upload date (newest first)</li>
|
||
<li>Title (A-Z)</li>
|
||
<li>Duration (shortest first)</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Media Library showing directory tree, filters, and video grid</em></p>
|
||
<h3 id="sharing-videos-publicly">Sharing Videos Publicly<a class="headerlink" href="#sharing-videos-publicly" title="Permanent link">¶</a></h3>
|
||
<p><strong>To make videos public:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Content > Media > Shared Media</strong></li>
|
||
<li>Select videos from library</li>
|
||
<li>Choose category:</li>
|
||
<li><strong>TESTIMONIAL</strong></li>
|
||
<li><strong>EVENT</strong></li>
|
||
<li><strong>EDUCATIONAL</strong></li>
|
||
<li><strong>PROMOTIONAL</strong></li>
|
||
<li>Click <strong>"Share"</strong></li>
|
||
</ol>
|
||
<p>Shared videos appear on the public media gallery at <code>/media</code>.</p>
|
||
<p><strong>To unshare videos:</strong></p>
|
||
<ol>
|
||
<li>Go to <strong>Shared Media</strong></li>
|
||
<li>Select videos</li>
|
||
<li>Click <strong>"Unshare"</strong></li>
|
||
</ol>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Shared Media page showing category filter and share/unshare buttons</em></p>
|
||
<h3 id="locking-videos">Locking Videos<a class="headerlink" href="#locking-videos" title="Permanent link">¶</a></h3>
|
||
<p><strong>Locked videos</strong> cannot be deleted or moved. Use locks to protect important content.</p>
|
||
<p><strong>To lock a video:</strong></p>
|
||
<ol>
|
||
<li>Select video in library</li>
|
||
<li>Click <strong>"Lock"</strong> (padlock icon)</li>
|
||
</ol>
|
||
<p><strong>To unlock:</strong></p>
|
||
<ol>
|
||
<li>Select locked video</li>
|
||
<li>Click <strong>"Unlock"</strong></li>
|
||
</ol>
|
||
<div class="admonition warning">
|
||
<p class="admonition-title">Lock Before Sharing</p>
|
||
<p>Lock videos before sharing publicly to prevent accidental deletion.</p>
|
||
</div>
|
||
<hr />
|
||
<h2 id="monitoring-reports">Monitoring & Reports<a class="headerlink" href="#monitoring-reports" title="Permanent link">¶</a></h2>
|
||
<h3 id="viewing-queue-status">Viewing Queue Status<a class="headerlink" href="#viewing-queue-status" title="Permanent link">¶</a></h3>
|
||
<p><strong>To monitor the email queue:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Influence > Email Queue</strong></li>
|
||
</ol>
|
||
<p><strong>Key metrics:</strong></p>
|
||
<ul>
|
||
<li><strong>Waiting</strong>: Emails queued for sending</li>
|
||
<li>High number = slow processing (check SMTP)</li>
|
||
<li><strong>Active</strong>: Currently processing</li>
|
||
<li>Should be 1-5 (concurrent workers)</li>
|
||
<li><strong>Completed</strong>: Sent in last 24 hours</li>
|
||
<li><strong>Failed</strong>: Delivery failures</li>
|
||
<li>Click "View Failed" to see error messages</li>
|
||
</ul>
|
||
<p><strong>Queue health indicators:</strong></p>
|
||
<ul>
|
||
<li><strong>Green</strong>: < 50 waiting, < 5 failed</li>
|
||
<li><strong>Yellow</strong>: 50-200 waiting, 5-20 failed</li>
|
||
<li><strong>Red</strong>: > 200 waiting, > 20 failed</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Email Queue dashboard showing job counts with color-coded health indicators</em></p>
|
||
<h3 id="geocoding-quality-dashboard">Geocoding Quality Dashboard<a class="headerlink" href="#geocoding-quality-dashboard" title="Permanent link">¶</a></h3>
|
||
<p><strong>To review geocoding quality:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Map > Data Quality</strong></li>
|
||
</ol>
|
||
<p><strong>Quality metrics:</strong></p>
|
||
<ul>
|
||
<li><strong>Total locations</strong>: All location records</li>
|
||
<li><strong>Geocoded</strong>: Have lat/lng coordinates</li>
|
||
<li><strong>Ungeocoded</strong>: Missing coordinates</li>
|
||
<li><strong>Low confidence</strong>: Confidence < 0.5</li>
|
||
<li><strong>Medium confidence</strong>: 0.5-0.8</li>
|
||
<li><strong>High confidence</strong>: > 0.8</li>
|
||
</ul>
|
||
<p><strong>Quality breakdown:</strong></p>
|
||
<ul>
|
||
<li><strong>Provider distribution</strong>: Which geocoding service was used</li>
|
||
<li><strong>Confidence histogram</strong>: Distribution of confidence scores</li>
|
||
<li><strong>Error analysis</strong>: Common geocoding failures</li>
|
||
</ul>
|
||
<p><strong>Actions:</strong></p>
|
||
<ul>
|
||
<li><strong>Re-geocode low confidence</strong>: Retry with different provider</li>
|
||
<li><strong>Export ungeocoded</strong>: CSV of failed addresses</li>
|
||
<li><strong>Manual review</strong>: Edit addresses and re-geocode</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Data Quality Dashboard showing geocoding statistics and confidence distribution chart</em></p>
|
||
<h3 id="canvass-completion-statistics">Canvass Completion Statistics<a class="headerlink" href="#canvass-completion-statistics" title="Permanent link">¶</a></h3>
|
||
<p><strong>To view canvass progress:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Canvass > Dashboard</strong></li>
|
||
</ol>
|
||
<p><strong>Completion metrics:</strong></p>
|
||
<ul>
|
||
<li><strong>Locations visited</strong>: Total unique addresses visited</li>
|
||
<li><strong>Visit rate</strong>: Visits per day/week</li>
|
||
<li><strong>Completion by cut</strong>: % of each cut visited</li>
|
||
<li><strong>Outcome breakdown</strong>: % NOT_HOME, REFUSED, SPOKE_WITH, etc.</li>
|
||
</ul>
|
||
<p><strong>Support level analysis:</strong></p>
|
||
<ul>
|
||
<li><strong>LEVEL_1</strong> (Strong support): Count and percentage</li>
|
||
<li><strong>LEVEL_2</strong> (Leaning support): Count and percentage</li>
|
||
<li><strong>LEVEL_3</strong> (Undecided): Count and percentage</li>
|
||
<li><strong>LEVEL_4</strong> (Opposition): Count and percentage</li>
|
||
</ul>
|
||
<p><strong>Volunteer performance:</strong></p>
|
||
<ul>
|
||
<li><strong>Sessions per volunteer</strong>: Distribution histogram</li>
|
||
<li><strong>Visits per volunteer</strong>: Leaderboard</li>
|
||
<li><strong>Average session duration</strong>: Time spent canvassing</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Canvass statistics showing completion gauges, outcome pie chart, and support level breakdown</em></p>
|
||
<h3 id="observability-dashboard">Observability Dashboard<a class="headerlink" href="#observability-dashboard" title="Permanent link">¶</a></h3>
|
||
<p><strong>To monitor system health:</strong></p>
|
||
<ol>
|
||
<li>Navigate to <strong>Observability</strong></li>
|
||
</ol>
|
||
<p>The observability dashboard has three tabs:</p>
|
||
<h4 id="metrics-tab">Metrics Tab<a class="headerlink" href="#metrics-tab" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Custom metrics</strong>: 12 <code>cm_*</code> Prometheus metrics</li>
|
||
<li>API uptime</li>
|
||
<li>Request counts</li>
|
||
<li>Email queue size</li>
|
||
<li>Active sessions</li>
|
||
<li>Geocoding success rate</li>
|
||
<li><strong>HTTP metrics</strong>: Request duration, status codes</li>
|
||
<li><strong>System metrics</strong>: CPU, memory, disk</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Metrics tab showing API uptime gauge and request count graph</em></p>
|
||
<h4 id="dashboards-tab">Dashboards Tab<a class="headerlink" href="#dashboards-tab" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Links to Grafana dashboards</strong>:</li>
|
||
<li>API Health (uptime, response times, error rates)</li>
|
||
<li>Queue Monitoring (email queue, geocoding queue)</li>
|
||
<li>Canvassing Activity (sessions, visits, outcomes)</li>
|
||
<li>Click dashboard name to open in Grafana</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Dashboards tab showing three dashboard cards with "Open" buttons</em></p>
|
||
<h4 id="alerts-tab">Alerts Tab<a class="headerlink" href="#alerts-tab" title="Permanent link">¶</a></h4>
|
||
<ul>
|
||
<li><strong>Active alerts</strong>: Currently firing alerts</li>
|
||
<li><strong>Alert history</strong>: Recent resolved alerts</li>
|
||
<li><strong>Alert rules</strong>: Configured thresholds</li>
|
||
<li><strong>Silence alerts</strong>: Temporarily mute alerts</li>
|
||
</ul>
|
||
<p><strong>Common alerts:</strong></p>
|
||
<ul>
|
||
<li><strong>API Down</strong>: API not responding</li>
|
||
<li><strong>High Error Rate</strong>: > 5% requests failing</li>
|
||
<li><strong>Queue Backed Up</strong>: > 1000 emails waiting</li>
|
||
<li><strong>Disk Space Low</strong>: < 10% free space</li>
|
||
</ul>
|
||
<p><strong>Screenshot placeholder</strong>: <em>Alerts tab showing active alert for "Queue Backed Up" with severity and details</em></p>
|
||
<hr />
|
||
<h2 id="troubleshooting">Troubleshooting<a class="headerlink" href="#troubleshooting" title="Permanent link">¶</a></h2>
|
||
<h3 id="common-admin-issues">Common Admin Issues<a class="headerlink" href="#common-admin-issues" title="Permanent link">¶</a></h3>
|
||
<h4 id="issue-cannot-log-in">Issue: Cannot Log In<a class="headerlink" href="#issue-cannot-log-in" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> "Invalid credentials" error</p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Verify email address</strong>: Check for typos, spaces</li>
|
||
<li><strong>Try password reset</strong>: Use "Forgot Password" link</li>
|
||
<li><strong>Check account status</strong>: Ask another admin if account is suspended</li>
|
||
<li><strong>Check browser console</strong>: Look for API errors</li>
|
||
</ol>
|
||
<h4 id="issue-emails-not-sending">Issue: Emails Not Sending<a class="headerlink" href="#issue-emails-not-sending" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> Emails stuck in "Waiting" status</p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Check SMTP configuration</strong>:</li>
|
||
<li>Navigate to <strong>Settings</strong></li>
|
||
<li>Verify SMTP host, port, username, password</li>
|
||
<li>Click "Send Test Email"</li>
|
||
<li><strong>Check email queue</strong>:</li>
|
||
<li>Navigate to <strong>Influence > Email Queue</strong></li>
|
||
<li>Look for error messages in failed jobs</li>
|
||
<li><strong>Check email test mode</strong>:</li>
|
||
<li>If <code>EMAIL_TEST_MODE=true</code>, emails go to MailHog (not real recipients)</li>
|
||
<li>Change in environment settings</li>
|
||
<li><strong>Restart queue worker</strong>:</li>
|
||
<li>Ask system administrator to restart api service</li>
|
||
</ol>
|
||
<h4 id="issue-csv-import-fails">Issue: CSV Import Fails<a class="headerlink" href="#issue-csv-import-fails" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> Error during CSV upload</p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Check CSV format</strong>:</li>
|
||
<li>Must be valid CSV (comma-separated)</li>
|
||
<li>First row must be headers</li>
|
||
<li>Required columns: address, city, province, postalCode</li>
|
||
<li><strong>Check file encoding</strong>:</li>
|
||
<li>Use UTF-8 encoding</li>
|
||
<li>Excel users: "Save As" > "CSV UTF-8"</li>
|
||
<li><strong>Check file size</strong>:</li>
|
||
<li>Maximum 10,000 rows per import</li>
|
||
<li>Split large files</li>
|
||
<li><strong>Check for special characters</strong>:</li>
|
||
<li>Remove emoji, unusual symbols</li>
|
||
<li>Use standard quotes ("not "" or '')</li>
|
||
</ol>
|
||
<h4 id="issue-geocoding-fails">Issue: Geocoding Fails<a class="headerlink" href="#issue-geocoding-fails" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> Addresses remain ungeocoded after import</p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Check address format</strong>:</li>
|
||
<li>Include full civic address</li>
|
||
<li>Include city and postal code</li>
|
||
<li>Use standard abbreviations (St, Ave, Rd)</li>
|
||
<li><strong>Check geocoding providers</strong>:</li>
|
||
<li>Navigate to <strong>Map > Data Quality</strong></li>
|
||
<li>See which providers are responding</li>
|
||
<li><strong>Try manual geocoding</strong>:</li>
|
||
<li>Edit location</li>
|
||
<li>Click and drag map pin to correct position</li>
|
||
<li>Save</li>
|
||
<li><strong>Use NAR data</strong> (Canada only):</li>
|
||
<li>NAR import includes pre-geocoded coordinates</li>
|
||
<li>More reliable than automatic geocoding</li>
|
||
</ol>
|
||
<h4 id="issue-map-not-loading">Issue: Map Not Loading<a class="headerlink" href="#issue-map-not-loading" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> Blank map or loading spinner</p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Check browser console</strong>: Look for JavaScript errors</li>
|
||
<li><strong>Check internet connection</strong>: Map tiles require network</li>
|
||
<li><strong>Try different browser</strong>: Test in Chrome, Firefox</li>
|
||
<li><strong>Clear browser cache</strong>: Hard refresh (Ctrl+Shift+R)</li>
|
||
<li><strong>Check locations</strong>:</li>
|
||
<li>Navigate to <strong>Map > Locations</strong></li>
|
||
<li>Verify locations have coordinates</li>
|
||
<li>At least one location needed to display map</li>
|
||
</ol>
|
||
<h4 id="issue-campaign-not-appearing-publicly">Issue: Campaign Not Appearing Publicly<a class="headerlink" href="#issue-campaign-not-appearing-publicly" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> Campaign visible in admin but not on <code>/campaigns</code></p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Check "Published" flag</strong>:</li>
|
||
<li>Edit campaign</li>
|
||
<li>Ensure "Published" toggle is ON</li>
|
||
<li>Save</li>
|
||
<li><strong>Check URL</strong>:</li>
|
||
<li>Campaign URL is <code>/campaigns/[slug]</code></li>
|
||
<li>Slug is auto-generated from title</li>
|
||
<li>Must be unique</li>
|
||
<li><strong>Clear browser cache</strong>: Public pages may be cached</li>
|
||
<li><strong>Check representative lookup</strong>:</li>
|
||
<li>Test with your postal code</li>
|
||
<li>If lookup fails, campaign won't display form</li>
|
||
</ol>
|
||
<h4 id="issue-volunteer-cannot-start-canvass-session">Issue: Volunteer Cannot Start Canvass Session<a class="headerlink" href="#issue-volunteer-cannot-start-canvass-session" title="Permanent link">¶</a></h4>
|
||
<p><strong>Symptoms:</strong> Error when volunteer clicks "Start Canvassing"</p>
|
||
<p><strong>Solutions:</strong></p>
|
||
<ol>
|
||
<li><strong>Check shift assignment</strong>:</li>
|
||
<li>Navigate to <strong>Map > Shifts</strong></li>
|
||
<li>Verify shift has a cut assigned</li>
|
||
<li>Shifts without cuts cannot be canvassed</li>
|
||
<li><strong>Check volunteer role</strong>:</li>
|
||
<li>Navigate to <strong>Users</strong></li>
|
||
<li>Verify volunteer is USER role (not TEMP)</li>
|
||
<li>Upgrade TEMP users to USER</li>
|
||
<li><strong>Check cut locations</strong>:</li>
|
||
<li>Navigate to <strong>Map > Cuts</strong></li>
|
||
<li>Verify cut has locations assigned</li>
|
||
<li>Empty cuts cannot be canvassed</li>
|
||
<li><strong>Check for existing session</strong>:</li>
|
||
<li>Volunteer may have abandoned session</li>
|
||
<li>Ask admin to close abandoned session</li>
|
||
</ol>
|
||
<h3 id="getting-help">Getting Help<a class="headerlink" href="#getting-help" title="Permanent link">¶</a></h3>
|
||
<p><strong>Documentation:</strong></p>
|
||
<ul>
|
||
<li><strong>Feature docs</strong>: <code>/docs/v2/features/</code> (detailed feature guides)</li>
|
||
<li><strong>API reference</strong>: <code>/docs/v2/api/</code> (API endpoint documentation)</li>
|
||
<li><strong>User guides</strong>: <code>/docs/v2/user-guides/</code> (this guide and others)</li>
|
||
<li><strong>Deployment</strong>: <code>/docs/v2/deployment/</code> (server setup, Docker, backups)</li>
|
||
</ul>
|
||
<p><strong>Support channels:</strong></p>
|
||
<ul>
|
||
<li><strong>GitHub Issues</strong>: Report bugs, request features</li>
|
||
<li><strong>Community Forum</strong>: Ask questions, share tips</li>
|
||
<li><strong>Email Support</strong>: Contact your system administrator</li>
|
||
</ul>
|
||
<p><strong>Before asking for help:</strong></p>
|
||
<ol>
|
||
<li>Check browser console for errors (F12)</li>
|
||
<li>Try in different browser</li>
|
||
<li>Check server logs (if you have access)</li>
|
||
<li>Document steps to reproduce issue</li>
|
||
</ol>
|
||
<hr />
|
||
<h2 id="related-documentation">Related Documentation<a class="headerlink" href="#related-documentation" title="Permanent link">¶</a></h2>
|
||
<ul>
|
||
<li><strong><a href="../volunteer-guide/">Volunteer Guide</a></strong>: Guide for volunteers using the canvassing portal</li>
|
||
<li><strong><a href="../campaign-manager-guide/">Campaign Manager Guide</a></strong>: Deep dive on campaign strategy and management</li>
|
||
<li><strong><a href="../map-organizer-guide/">Map Organizer Guide</a></strong>: Advanced location and territory management</li>
|
||
<li><strong><a href="../content-editor-guide/">Content Editor Guide</a></strong>: Landing pages and media library</li>
|
||
<li><strong><a href="../features/influence.md">Influence Module</a></strong>: Technical details on campaigns and email sending</li>
|
||
<li><strong><a href="../features/map.md">Map Module</a></strong>: Technical details on geocoding and canvassing</li>
|
||
<li><strong><a href="../api/overview.md">API Reference</a></strong>: REST API documentation for integrations</li>
|
||
</ul>
|
||
<hr />
|
||
<p><strong>Last updated</strong>: February 2026 (V2 complete)</p>
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
|
||
</article>
|
||
</div>
|
||
|
||
|
||
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
|
||
</div>
|
||
|
||
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
|
||
Back to top
|
||
</button>
|
||
|
||
</main>
|
||
|
||
<footer class="md-footer">
|
||
|
||
|
||
|
||
<nav class="md-footer__inner md-grid" aria-label="Footer" >
|
||
|
||
|
||
<a href="../" class="md-footer__link md-footer__link--prev" aria-label="Previous: User Guides">
|
||
<div class="md-footer__button md-icon">
|
||
|
||
<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>
|
||
</div>
|
||
<div class="md-footer__title">
|
||
<span class="md-footer__direction">
|
||
Previous
|
||
</span>
|
||
<div class="md-ellipsis">
|
||
User Guides
|
||
</div>
|
||
</div>
|
||
</a>
|
||
|
||
|
||
|
||
<a href="../campaign-manager-guide/" class="md-footer__link md-footer__link--next" aria-label="Next: Campaign Manager Guide">
|
||
<div class="md-footer__title">
|
||
<span class="md-footer__direction">
|
||
Next
|
||
</span>
|
||
<div class="md-ellipsis">
|
||
Campaign Manager Guide
|
||
</div>
|
||
</div>
|
||
<div class="md-footer__button md-icon">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M4 11v2h12l-5.5 5.5 1.42 1.42L19.84 12l-7.92-7.92L10.5 5.5 16 11z"/></svg>
|
||
</div>
|
||
</a>
|
||
|
||
</nav>
|
||
|
||
|
||
<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 © 2024 The Bunker Operations – <a href="#__consent">Change cookie settings</a>
|
||
|
||
</div>
|
||
|
||
|
||
</div>
|
||
|
||
|
||
<div class="md-social">
|
||
|
||
|
||
|
||
|
||
|
||
<a href="https://gitea.bnkops.com/admin" target="_blank" rel="noopener" title="Gitea Repository" class="md-social__link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M173.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M252.8 8C114.1 8 8 113.3 8 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C436.2 457.8 504 362.9 504 252 504 113.3 391.5 8 252.8 8M105.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
|
||
</a>
|
||
|
||
|
||
|
||
|
||
|
||
<a href="https://listmonk.bnkops.com/subscription/form" target="_blank" rel="noopener" title="Newsletter" class="md-social__link">
|
||
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!--! Font Awesome Free 7.1.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path d="M536.4-26.3c9.8-3.5 20.6-1 28 6.3s9.8 18.2 6.3 28l-178 496.9c-5 13.9-18.1 23.1-32.8 23.1-14.2 0-27-8.6-32.3-21.7l-64.2-158c-4.5-11-2.5-23.6 5.2-32.6l94.5-112.4c5.1-6.1 4.7-15-.9-20.6s-14.6-6-20.6-.9l-112.4 94.3c-9.1 7.6-21.6 9.6-32.6 5.2L38.1 216.8c-13.1-5.3-21.7-18.1-21.7-32.3 0-14.7 9.2-27.8 23.1-32.8z"/></svg>
|
||
</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">{"annotate": null, "base": "../../..", "features": ["announce.dismiss", "content.action.edit", "content.action.view", "content.code.annotate", "content.code.copy", "content.tooltips", "navigation.expand", "navigation.footer", "navigation.indexes", "navigation.path", "navigation.prune", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking", "search.highlight", "search.share", "search.suggest", "toc.follow"], "search": "../../../assets/javascripts/workers/search.2c215733.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.79ae519e.min.js"></script>
|
||
|
||
<script src="../../../javascripts/home.js"></script>
|
||
|
||
<script src="../../../javascripts/github-widget.js"></script>
|
||
|
||
<script src="../../../javascripts/gitea-widget.js"></script>
|
||
|
||
<script src="../../../assets/js/env-config.js"></script>
|
||
|
||
<script src="../../../assets/js/video-player.js"></script>
|
||
|
||
|
||
</body>
|
||
</html> |