summaryrefslogtreecommitdiff
path: root/site/server/ddns
diff options
context:
space:
mode:
authorjoshua <joshua@joshuayun.com>2023-12-29 23:18:01 -0500
committerjoshua <joshua@joshuayun.com>2023-12-29 23:18:01 -0500
commitbe0a9dfcbd5ea62eca32f3cebb104ae39855a4f2 (patch)
tree05e8c68e2adb022e7b6d3b0ecf3799aaf1f795ec /site/server/ddns
parent801b59c05ac3c12e74a5f77c0d5d6f898ef55912 (diff)
downloadwiki-be0a9dfcbd5ea62eca32f3cebb104ae39855a4f2.tar.gz
updated wiki on how to make server
Diffstat (limited to 'site/server/ddns')
-rw-r--r--site/server/ddns/index.html612
1 files changed, 612 insertions, 0 deletions
diff --git a/site/server/ddns/index.html b/site/server/ddns/index.html
new file mode 100644
index 0000000..a81e917
--- /dev/null
+++ b/site/server/ddns/index.html
@@ -0,0 +1,612 @@
+
+<!doctype html>
+<html lang="en" class="no-js">
+ <head>
+
+ <meta charset="utf-8">
+ <meta name="viewport" content="width=device-width,initial-scale=1">
+
+
+
+ <link rel="canonical" href="https://wiki.joshuayun.com/server/ddns/">
+
+
+ <link rel="prev" href="../cgit/">
+
+
+ <link rel="next" href="../../about/">
+
+
+ <link rel="icon" href="../../assets/images/favicon.png">
+ <meta name="generator" content="mkdocs-1.5.3, mkdocs-material-9.5.1">
+
+
+
+ <title>DDNS - Joshua's Wiki</title>
+
+
+
+ <link rel="stylesheet" href="../../assets/stylesheets/main.45e1311d.min.css">
+
+
+
+
+
+
+
+
+
+
+
+
+ <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
+ <link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
+ <style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
+
+
+
+ <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>
+
+
+
+
+
+
+ </head>
+
+
+ <body dir="ltr">
+
+
+ <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="#ddns-setup" class="md-skip">
+ Skip to content
+ </a>
+
+ </div>
+ <div data-md-component="announce">
+
+ </div>
+
+
+
+
+
+
+<header class="md-header md-header--shadow" data-md-component="header">
+ <nav class="md-header__inner md-grid" aria-label="Header">
+ <a href="../.." title="Joshua&#39;s Wiki" class="md-header__button md-logo" aria-label="Joshua's Wiki" data-md-component="logo">
+
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
+ </a>
+ <label class="md-header__button md-icon" for="__drawer">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z"/></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">
+ Joshua's Wiki
+ </span>
+ </div>
+ <div class="md-header__topic" data-md-component="header-topic">
+ <span class="md-ellipsis">
+
+ DDNS
+
+ </span>
+ </div>
+ </div>
+ </div>
+
+
+ <script>var media,input,key,value,palette=__md_get("__palette");if(palette&&palette.color){"(prefers-color-scheme)"===palette.color.media&&(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([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.516 6.516 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 5Z"/></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.516 6.516 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 5Z"/></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 11h12Z"/></svg>
+ </label>
+ <nav class="md-search__options" aria-label="Search">
+
+ <button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12 19 6.41Z"/></svg>
+ </button>
+ </nav>
+
+ </form>
+ <div class="md-search__output">
+ <div class="md-search__scrollwrap" data-md-scrollfix>
+ <div class="md-search-result" data-md-component="search-result">
+ <div class="md-search-result__meta">
+ Initializing search
+ </div>
+ <ol class="md-search-result__list" role="presentation"></ol>
+ </div>
+ </div>
+ </div>
+ </div>
+</div>
+
+
+ </nav>
+
+</header>
+
+ <div class="md-container" data-md-component="container">
+
+
+
+
+
+
+ <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" aria-label="Navigation" data-md-level="0">
+ <label class="md-nav__title" for="__drawer">
+ <a href="../.." title="Joshua&#39;s Wiki" class="md-nav__button md-logo" aria-label="Joshua's Wiki" data-md-component="logo">
+
+
+ <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a3 3 0 0 0 3-3 3 3 0 0 0-3-3 3 3 0 0 0-3 3 3 3 0 0 0 3 3m0 3.54C9.64 9.35 6.5 8 3 8v11c3.5 0 6.64 1.35 9 3.54 2.36-2.19 5.5-3.54 9-3.54V8c-3.5 0-6.64 1.35-9 3.54Z"/></svg>
+
+ </a>
+ Joshua's Wiki
+ </label>
+
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../.." class="md-nav__link">
+
+
+ <span class="md-ellipsis">
+ Home
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active md-nav__item--nested">
+
+
+
+
+ <input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
+
+
+ <label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="0">
+
+
+ <span class="md-ellipsis">
+ Server
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <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>
+ Server
+ </label>
+ <ul class="md-nav__list" data-md-scrollfix>
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../server/" class="md-nav__link">
+
+
+ <span class="md-ellipsis">
+ Server Setup
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../cgit/" class="md-nav__link">
+
+
+ <span class="md-ellipsis">
+ Cgit with gitolite
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item md-nav__item--active">
+
+ <input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
+
+
+
+
+
+ <label class="md-nav__link md-nav__link--active" for="__toc">
+
+
+ <span class="md-ellipsis">
+ DDNS
+ </span>
+
+
+ <span class="md-nav__icon md-icon"></span>
+ </label>
+
+ <a href="./" class="md-nav__link md-nav__link--active">
+
+
+ <span class="md-ellipsis">
+ DDNS
+ </span>
+
+
+ </a>
+
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#porkbun-api" class="md-nav__link">
+ <span class="md-ellipsis">
+ Porkbun API
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#ddns-updater" class="md-nav__link">
+ <span class="md-ellipsis">
+ ddns-updater
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="ddns-updater">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#docker-install" class="md-nav__link">
+ <span class="md-ellipsis">
+ Docker install
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#setup" class="md-nav__link">
+ <span class="md-ellipsis">
+ Setup
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#usage" class="md-nav__link">
+ <span class="md-ellipsis">
+ Usage
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+
+</nav>
+
+ </li>
+
+
+
+
+ </ul>
+ </nav>
+
+ </li>
+
+
+
+
+
+
+
+
+
+ <li class="md-nav__item">
+ <a href="../../about/" class="md-nav__link">
+
+
+ <span class="md-ellipsis">
+ About
+ </span>
+
+
+ </a>
+ </li>
+
+
+
+ </ul>
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
+ <div class="md-sidebar__scrollwrap">
+ <div class="md-sidebar__inner">
+
+
+<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
+
+
+
+
+
+
+ <label class="md-nav__title" for="__toc">
+ <span class="md-nav__icon md-icon"></span>
+ Table of contents
+ </label>
+ <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
+
+ <li class="md-nav__item">
+ <a href="#porkbun-api" class="md-nav__link">
+ <span class="md-ellipsis">
+ Porkbun API
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#ddns-updater" class="md-nav__link">
+ <span class="md-ellipsis">
+ ddns-updater
+ </span>
+ </a>
+
+ <nav class="md-nav" aria-label="ddns-updater">
+ <ul class="md-nav__list">
+
+ <li class="md-nav__item">
+ <a href="#docker-install" class="md-nav__link">
+ <span class="md-ellipsis">
+ Docker install
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#setup" class="md-nav__link">
+ <span class="md-ellipsis">
+ Setup
+ </span>
+ </a>
+
+</li>
+
+ <li class="md-nav__item">
+ <a href="#usage" class="md-nav__link">
+ <span class="md-ellipsis">
+ Usage
+ </span>
+ </a>
+
+</li>
+
+ </ul>
+ </nav>
+
+</li>
+
+ </ul>
+
+</nav>
+ </div>
+ </div>
+ </div>
+
+
+
+ <div class="md-content" data-md-component="content">
+ <article class="md-content__inner md-typeset">
+
+
+
+
+<h1 id="ddns-setup">DDNS Setup</h1>
+<h2 id="porkbun-api">Porkbun API</h2>
+<p>Follow this <a href="https://kb.porkbun.com/article/190-getting-started-with-the-porkbun-api">porkbun</a> guide on enabling the api for your domain.</p>
+<h2 id="ddns-updater">ddns-updater</h2>
+<p><a href="https://github.com/qdm12/ddns-updater">ddns-updater</a> is the program used to update Porkbun's A record of your domain.</p>
+<h3 id="docker-install">Docker install</h3>
+<p>Install the <a href="https://docs.docker.com/engine/install/debian/">docker</a> package from official docker repositories.</p>
+<h3 id="setup">Setup</h3>
+<p>Create a directory with config.json inside, and make sure that its owner has a uid of 1000.</p>
+<pre><code>mkdir data
+touch data/config.json
+# Owned by user ID of Docker container (1000)
+chown -R 1000 data
+# all access (for creating json database file data/updates.json)
+chmod 700 data
+# read access only
+chmod 400 data/config.json
+</code></pre>
+<p>Configuration for porkbun in config.json</p>
+<pre><code>{
+ "settings": [
+ {
+ "provider": "porkbun",
+ "domain": "domain.com",
+ "host": "@",
+ "api_key": "PORKBUN SECRET KEY",
+ "secret_api_key": "PORKBUN API KEY",
+ "ip_version": "ipv4"
+ }
+ ]
+}
+</code></pre>
+<p>Optional <code>"ttl"</code> paramter specifing A record TTL not included.</p>
+<h3 id="usage">Usage</h3>
+<pre><code>docker run -d -p 8000:8000/tcp -v "$(pwd)"/data:/updater/data qmcgaw/ddns-updater
+</code></pre>
+<p>This will start a docker container that will start updating the DNS records.
+Status updates can be seen in a web server by going to localhost:8000.</p>
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </article>
+ </div>
+
+
+<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
+ </div>
+
+ </main>
+
+ <footer class="md-footer">
+
+ <div class="md-footer-meta md-typeset">
+ <div class="md-footer-meta__inner md-grid">
+ <div class="md-copyright">
+
+
+ Made with
+ <a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
+ Material for MkDocs
+ </a>
+
+</div>
+
+ </div>
+ </div>
+</footer>
+
+ </div>
+ <div class="md-dialog" data-md-component="dialog">
+ <div class="md-dialog__inner md-typeset"></div>
+ </div>
+
+
+ <script id="__config" type="application/json">{"base": "../..", "features": [], "search": "../../assets/javascripts/workers/search.f886a092.min.js", "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"}}</script>
+
+
+ <script src="../../assets/javascripts/bundle.d7c377c4.min.js"></script>
+
+
+ </body>
+</html> \ No newline at end of file
generated by cgit v1.2.3 (git 2.39.1) at 2024-09-19 21:45:31 +0000