mirror of
https://github.com/TxtDot/documentation.git
synced 2024-10-16 19:58:07 +03:00
536 lines
19 KiB
HTML
536 lines
19 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">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="prev" href="..">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="icon" href="../assets/images/favicon.png">
|
||
|
|
<meta name="generator" content="mkdocs-1.5.2, mkdocs-material-9.2.5">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<title>Self-Hosting - txtdot</title>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../assets/stylesheets/main.0e669242.min.css">
|
||
|
|
|
||
|
|
|
||
|
|
<link rel="stylesheet" href="../assets/stylesheets/palette.85d0ee34.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" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<script>var palette=__md_get("__palette");if(palette&&"object"==typeof palette.color)for(var key of Object.keys(palette.color))document.body.setAttribute("data-md-color-"+key,palette.color[key])</script>
|
||
|
|
|
||
|
|
<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="#self-hosting" 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="txtdot" class="md-header__button md-logo" aria-label="txtdot" 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">
|
||
|
|
txtdot
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
<div class="md-header__topic" data-md-component="header-topic">
|
||
|
|
<span class="md-ellipsis">
|
||
|
|
|
||
|
|
Self-Hosting
|
||
|
|
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
<form class="md-header__option" data-md-component="palette">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" 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_2" hidden>
|
||
|
|
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
|
||
|
|
</label>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_2">
|
||
|
|
|
||
|
|
<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="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z"/></svg>
|
||
|
|
</label>
|
||
|
|
|
||
|
|
|
||
|
|
</form>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<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>
|
||
|
|
|
||
|
|
|
||
|
|
<div class="md-header__source">
|
||
|
|
<a href="https://github.com/txtdot/txtdot" 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 496 512"><!--! Font Awesome Free 6.4.2 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 2023 Fonticons, Inc.--><path d="M165.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.6zm-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.3zm44.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.9zM244.8 8C106.1 8 0 113.3 0 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.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.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-1zm-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.7zm32.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-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
||
|
|
</div>
|
||
|
|
<div class="md-source__repository">
|
||
|
|
txtdot/txtdot
|
||
|
|
</div>
|
||
|
|
</a>
|
||
|
|
</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="txtdot" class="md-nav__button md-logo" aria-label="txtdot" 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>
|
||
|
|
txtdot
|
||
|
|
</label>
|
||
|
|
|
||
|
|
<div class="md-nav__source">
|
||
|
|
<a href="https://github.com/txtdot/txtdot" 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 496 512"><!--! Font Awesome Free 6.4.2 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 2023 Fonticons, Inc.--><path d="M165.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.6zm-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.3zm44.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.9zM244.8 8C106.1 8 0 113.3 0 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.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8zM97.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-1zm-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.7zm32.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-1zm-11.4-14.7c-1.6 1-1.6 3.6 0 5.9 1.6 2.3 4.3 3.3 5.6 2.3 1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2z"/></svg>
|
||
|
|
</div>
|
||
|
|
<div class="md-source__repository">
|
||
|
|
txtdot/txtdot
|
||
|
|
</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">
|
||
|
|
Getting Started
|
||
|
|
</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">
|
||
|
|
Self-Hosting
|
||
|
|
</span>
|
||
|
|
|
||
|
|
|
||
|
|
<span class="md-nav__icon md-icon"></span>
|
||
|
|
</label>
|
||
|
|
|
||
|
|
<a href="./" class="md-nav__link md-nav__link--active">
|
||
|
|
|
||
|
|
|
||
|
|
<span class="md-ellipsis">
|
||
|
|
Self-Hosting
|
||
|
|
</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="#without-docker" class="md-nav__link">
|
||
|
|
Without Docker
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<nav class="md-nav" aria-label="Without Docker">
|
||
|
|
<ul class="md-nav__list">
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#add-txtdot-to-autostart" class="md-nav__link">
|
||
|
|
Add txtdot to autostart
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#with-docker" class="md-nav__link">
|
||
|
|
With Docker
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</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="#without-docker" class="md-nav__link">
|
||
|
|
Without Docker
|
||
|
|
</a>
|
||
|
|
|
||
|
|
<nav class="md-nav" aria-label="Without Docker">
|
||
|
|
<ul class="md-nav__list">
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#add-txtdot-to-autostart" class="md-nav__link">
|
||
|
|
Add txtdot to autostart
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
</nav>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
<li class="md-nav__item">
|
||
|
|
<a href="#with-docker" class="md-nav__link">
|
||
|
|
With Docker
|
||
|
|
</a>
|
||
|
|
|
||
|
|
</li>
|
||
|
|
|
||
|
|
</ul>
|
||
|
|
|
||
|
|
</nav>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<div class="md-content" data-md-component="content">
|
||
|
|
<article class="md-content__inner md-typeset">
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
<h1 id="self-hosting">Self-Hosting</h1>
|
||
|
|
<h2 id="without-docker">Without Docker</h2>
|
||
|
|
<p>Install Node and NPM:</p>
|
||
|
|
<pre><code class="language-bash"># Debian, Ubuntu
|
||
|
|
sudo apt install nodejs npm
|
||
|
|
# CentOS
|
||
|
|
sudo yum install nodejs
|
||
|
|
# Arch
|
||
|
|
sudo pacman -S nodejs npm
|
||
|
|
# Alpine
|
||
|
|
doas apk add nodejs npm
|
||
|
|
</code></pre>
|
||
|
|
<p>Create a user for txtdot, log in:</p>
|
||
|
|
<pre><code class="language-bash"># Not Alpine (coreutils)
|
||
|
|
sudo useradd -r -m -s /sbin/nologin -U txtdot
|
||
|
|
sudo -u txtdot -i
|
||
|
|
|
||
|
|
# Alpine (busybox)
|
||
|
|
doas addgroup -S txtdot
|
||
|
|
doas adduser -h /home/txtdot -s /sbin/nologin -G txtdot -S -D txtdot
|
||
|
|
doas -u txtdot bash
|
||
|
|
</code></pre>
|
||
|
|
<p>Clone the repo: </p>
|
||
|
|
<pre><code class="language-bash">git clone https://github.com/txtdot/txtdot.git src
|
||
|
|
</code></pre>
|
||
|
|
<p>Install packages, compile TS:</p>
|
||
|
|
<pre><code class="language-bash">cd src
|
||
|
|
npm install
|
||
|
|
npm run build
|
||
|
|
</code></pre>
|
||
|
|
<p>Manually start the server to check if it works (Ctrl+C to exit):</p>
|
||
|
|
<pre><code class="language-bash">npm run start
|
||
|
|
</code></pre>
|
||
|
|
<p>Log out from txtdot account: <code>exit</code></p>
|
||
|
|
<h3 id="add-txtdot-to-autostart">Add txtdot to autostart</h3>
|
||
|
|
<p>Either using systemd unit file:</p>
|
||
|
|
<pre><code class="language-bash">wget https://github.com/TxtDot/txtdot/blob/main/txtdot.service
|
||
|
|
sudo chown root:root txtdot.service
|
||
|
|
sudo chmod 755 txtdot.service
|
||
|
|
sudo mv txtdot.service /etc/systemd/system/
|
||
|
|
sudo systemctl daemon-reload
|
||
|
|
sudo systemctl enable txtdot
|
||
|
|
sudo systemctl start txtdot
|
||
|
|
</code></pre>
|
||
|
|
<p>Or using OpenRC script:</p>
|
||
|
|
<pre><code class="language-bash">wget -O txtdot https://github.com/TxtDot/txtdot/blob/main/txtdot.init
|
||
|
|
doas chown root:root txtdot
|
||
|
|
doas chmod 755 txtdot
|
||
|
|
doas mv txtdot /etc/init.d/
|
||
|
|
doas rc-update add txtdot
|
||
|
|
doas rc-service txtdot start
|
||
|
|
</code></pre>
|
||
|
|
<p>Or using crontab:</p>
|
||
|
|
<pre><code class="language-bash">sudo crontab -u txtdot -e
|
||
|
|
# The command will open an editor
|
||
|
|
# Add this line to the end of the file:
|
||
|
|
@reboot sleep 10 && cd /home/txtdot/src && npm run start
|
||
|
|
# Save the file and exit
|
||
|
|
</code></pre>
|
||
|
|
<h2 id="with-docker">With Docker</h2>
|
||
|
|
<p>Docker Engine and Docker Compose are required.</p>
|
||
|
|
<p>Note that built images are not provided via Docker Hub.
|
||
|
|
If you can't or don't want to build them on your server
|
||
|
|
and don't want to setup a CI/CD system,
|
||
|
|
<a href="https://github.com/txtdot/txtdot/issues">let us know</a>,
|
||
|
|
we'll consider setting up a GitHub Actions workflow.</p>
|
||
|
|
<pre><code class="language-bash">git clone https://github.com/txtdot/txtdot.git
|
||
|
|
cd txtdot
|
||
|
|
docker compose build
|
||
|
|
docker compose up -d
|
||
|
|
</code></pre>
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
|
||
|
|
</article>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
|
||
|
|
</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.dfff1995.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.78eede0e.min.js"></script>
|
||
|
|
|
||
|
|
|
||
|
|
</body>
|
||
|
|
</html>
|