<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/INSTALLATION.md - fork/chhoto-url @ unicode</title>
<meta name="description" content="docs/INSTALLATION.md in fork/chhoto-url at unicode.">
<meta property="og:title" content="docs/INSTALLATION.md - fork/chhoto-url @ unicode">
<meta property="og:description" content="docs/INSTALLATION.md in fork/chhoto-url at unicode.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="unicode" data-tip="82d990341772a1a355f33bfc992a3e69d7ae0726">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/chhoto-url</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/chhoto-url</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">SinTan1729</span><span class="commit-message" data-commit="75a18a27f91f137881053341b7982fa70ec0392a">docs: Fix the favicon location</span><span class="snapshot-sha sha" data-commit="75a18a27f91f137881053341b7982fa70ec0392a">75a18a2</span><time datetime="2026-09-21T16:41:10-05:00" title="2026-09-21 16:41:10 -0500">2026-09-21</time></p>
<header class="topbar"><details class="switcher"><summary>unicode</summary><div class="menu"><strong>branches</strong><a class="current" href="/fork/chhoto-url/ref/unicode/">unicode</a><a class="all" href="/fork/chhoto-url/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/chhoto-url/">chhoto-url</a> / <a href="/fork/chhoto-url/ref/unicode/tree/docs/">docs</a> / <span class="cur">INSTALLATION.md</span></nav>
<span class="view-stats"><span>16.6 KiB</span><span>353 lines</span></span><span class="actions"><a class="raw" href="/fork/chhoto-url/raw/1e39236be9873979ac62cb0c5d2198937b5dff51/docs/INSTALLATION.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered">&lt;!-- SPDX-FileCopyrightText: 2023-2026 Sayantan Santra &lt;sayantan.santra689@gmail.com&gt; --&gt;
&lt;!-- SPDX-License-Identifier: MIT --&gt;
<h1>Installation and Configuration</h1>
<h2>Using Docker Compose or Podman Quadlets (Recommended method)</h2>
<p>The repository includes a <a href="/fork/chhoto-url/ref/unicode/blob/deploy/compose.yaml">sample <code>compose.yaml</code> file</a>. It contains
everything needed for a basic deployment.
Starting with version 6.2.6, OCI images are built by a GitHub Actions workflow.
You can <a href="/fork/chhoto-url/ref/unicode/blob/.github/workflows/test-and-release.yml">check the workflow for yourself</a> to make sure that nothing silly is going on.</p>
<p>The container images come in two flavors. The default image is built from <a href="https://hub.docker.com/_/scratch"><code>scratch</code></a>,
and is as light as possible. The tags with the <code>-alpine</code> suffix are built on top of <a href="https://hub.docker.com/_/alpine"><code>alpine</code></a>.
These images are slightly larger, but include basic Unix tools that can be useful for debugging or for inspecting the container
interactively. The <code>dev</code> tags are always built on top of <code>alpine</code> and are intended for testing only; <strong>do not use these for production
workloads.</strong> The tags <code>latest</code> and <code>scratch</code> are synonymous, as are <code>latest-alpine</code> and <code>alpine</code>.</p>
<p>All of these images are available both on the Docker Hub (recommended) and GHCR, except for <code>dev</code> builds, which are published
only to GHCR. They are built for Linux on the <code>linux/amd64</code>, <code>linux/arm64</code>, <code>linux/arm/v7</code>, and <code>linux/riscv64</code> architectures.
The images should also work with Podman and other OCI-compatible container engines.</p>
<p>You can use the provided <code>compose</code> file as a base, modifying it as needed. Run it with</p>
<pre>docker compose up -d
</pre>
<p>If you're using a custom location for the <a href="#chhoto_db_url"><code>CHHOTO_DB_URL</code></a>, and using WAL mode, make sure to mount a whole
directory instead of a folder. If this is not done, there will be a low, but non-zero chance of data corruption.</p>
<p>It should be possible to run Chhoto URL with pretty much anything that supports OCI images e.g. <code>docker</code>, <code>podman quadlets</code>
(the repo contains a sample <a href="/fork/chhoto-url/ref/unicode/blob/deploy/chhoto-url.container"><code>chhoto-url.container</code></a> file for using with <code>quadlets</code>.) etc. Official
support is only provided for <code>docker</code> and <code>podman</code>, but it should be trivial to convert the <code>compose.yaml</code> file to other formats.
If you need help, feel free to open a discussion.</p>
<h2>Building and running with Docker</h2>
<h3><code>docker run</code> method</h3>
<ol start="0">
<li>(Only if you really want to) Build the image for the default <code>x86_64-unknown-linux-musl</code> target:</li>
</ol>
<pre>docker build -f build/Containerfile . -t chhoto-url
</pre>
<p>For building on <code>arm64</code>, <code>arm/v7</code>, or <code>riscv64</code>, use the following:</p>
<pre>docker build -f build/Containerfile . -t chhoto-url --build-arg target=&lt;desired-target&gt;
</pre>
<p>Make sure that the desired target is a <code>musl</code> one, since the docker image is built from <code>scratch</code>.
For cross-compilation, take a look at the <code>Makefile</code>. It has instructions to build the architectures
mentioned above., For any other architectures, open a discussion, and I'll try to help you out.</p>
<ol>
<li>Run the image</li>
</ol>
<pre>docker run -p 4567:4567 \
    -f build/Containerfile \
    -e CHHOTO_PASSWORD=&quot;password&quot; \
    -d chhoto-url:alpine
</pre>
<p>1.a Make the database file available to host (optional)</p>
<pre>touch ./urls.sqlite
docker run -p 4567:4567 \
    -f build/Containerfile
    -e CHHOTO_PASSWORD=&quot;password&quot; \
    -v ./data:/data \
    -e CHHOTO_DB_URL=/data/urls.sqlite \
    -d chhoto-url:alpine
</pre>
<p><em>Note: All of this pretty much works exactly the same if you replace <code>docker</code> with <code>podman</code>. In fact,
that's what I use for testing. A sample file for podman quadlets is provided at
<a href="/fork/chhoto-url/ref/unicode/blob/deploy/chhoto-url.container"><code>chhoto-url.container</code></a></em></p>
<h2>Configuration options</h2>
<p>All the configuration is done using environmental variables. Here's a link of all supported ones. Please take
a look at the ones marked with a <code>#</code> as those are important, especially <a href="#chhoto_sqlite_use_wal_mode"><code>CHHOTO_SQLITE_USE_WAL_MODE</code></a>.</p>
&lt;!-- prettier-ignore-start --&gt;
<p>&lt;a id="chhoto_db_url"&gt;&lt;/a&gt;</p>
<h3><code>CHHOTO_DB_URL</code> #</h3>
&lt;!-- prettier-ignore-end --&gt;
<p>Location for the database file. Take a look at <a href="#chhoto_sqlite_use_wal_mode"><code>CHHOTO_SQLITE_USE_WAL_MODE</code></a> before you change it. Defaults to
<code>urls.sqlite</code>. It is highly recommended that you mount a named volume or directory at a location like <code>/data</code> and
use something like <code>/data/urls.sqlite</code> here.
(Of course, the actual names being used don't really matter.)</p>
&lt;!-- prettier-ignore-start --&gt;
<p>&lt;a id="chhoto_password"&gt;&lt;/a&gt;</p>
<h3><code>CHHOTO_PASSWORD</code> #</h3>
&lt;!-- prettier-ignore-end --&gt;
<p>Provide a secure password. If kept empty, anyone can access the website. Note that password is not encrypted in
transport, so it's recommended to use a reverse proxy like <code>caddy</code> or <code>nginx</code>.</p>
&lt;!-- prettier-ignore-start --&gt;
<p>&lt;a id="chhoto_site_url"&gt;&lt;/a&gt;</p>
<h3><code>CHHOTO_SITE_URL</code> #</h3>
&lt;!-- prettier-ignore-end --&gt;
<p>Change this to your public-facing URL. This is optional, as the link will work at any URL as long as Chhoto URL
is accessible there. This mostly enhances the frontend experience, as copying to clipboard, QR code generation will
use it if available.
Do not surround it using quotes. If you have any unicode characters, please use the punycode. It'll be automatically
converted to the correct unicode in the frontend.</p>
<h3><code>CHHOTO_API_KEY</code></h3>
<p>Provide a secure API key. It'll be checked at start for security. If the API key is considered weak, a strong API
key will be generated and printed in the logs, but the weak one will be used for the time being.</p>
<p>Example Linux command for generating a secure API key: <code>tr -dc A-Za-z0-9 &lt;/dev/urandom | head -c 128</code>.</p>
<p>If no API key is provided, the website will still work, but it'll be a significantly worse experience if you try
to use Chhoto URL from the CLI.</p>
&lt;!-- prettier-ignore-start --&gt;
<p>&lt;a id="chhoto_sqlite_use_wal_mode"&gt;&lt;/a&gt;</p>
<h3><code>CHHOTO_SQLITE_USE_WAL_MODE</code> #</h3>
&lt;!-- prettier-ignore-end --&gt;
<p>If set to <code>True</code>, enables <a href="https://sqlite.org/wal.html"><code>WAL</code> journal mode</a>. Any other value is ignored.
It's highly recommended that you enable it, but make sure that you mount either a whole directory, or a named
volume, and have the database inside it. DO NOT mount a single file, as there will be a small chance of partial
data loss in that case.</p>
<p>If this is enabled, there'll be a significant boost in performance under high load, since write will no longer block reads.
Otherwise, <code>DELETE</code> journal mode is used by default, along with <a href="https://sqlite.org/pragma.html#pragma_synchronous"><code>EXTRA</code> synchronous</a>
pragma. In <code>WAL</code> mode, <code>FULL</code> synchronous pragma is used instead.</p>
<p>In both cases, we have full ACID compliance, but it does cost a bit of performance. If you expect to see high throughput (in the
order of hundreds of read/writes per second), take a look at the <a href="#chhoto_sqlite_ensure_acid"><code>CHHOTO_SQLITE_ENSURE_ACID</code></a> configuration option.</p>
<h3><code>CHHOTO_SQLITE_ENSURE_ACID</code></h3>
<p>By default, the database is
<a href="https://www.slingacademy.com/article/acid-properties-in-sqlite-why-they-matter">ACID (i.e. Atomic, Consistent, Isolated, and Durable)</a>.
If you'd like to let go of durability for an increase in throughput, set this to <code>False</code>. Any other value will be ignored.</p>
<p>This is done by setting the <a href="https://sqlite.org/pragma.html#pragma_synchronous">synchronous pragma</a> to <code>FULL</code> in <code>WAL</code>
<a href="https://sqlite.org/pragma.html#pragma_journal_mode">journal mode</a>, and to <code>EXTRA</code> in <code>DELETE</code> journal mode.</p>
<p><em>Note: There might be partial data loss only in case of system failure or power loss. Durability is maintained across application
crashes. If you do have data loss, you should only lose the data stored after the last sync with the database file. So, under normal
loads, you shouldn't lose any data anyway. But this is a real thing that can technically happen.</em></p>
<h3><code>CHHOTO_DISABLE_BACKUPS</code></h3>
<p>Set this to <code>True</code> to disable the automated database backups. Only do this if you have another strategy for backups, or you truly don't
care about your data. <strong>You've been warned.</strong></p>
&lt;!-- prettier-ignore-start --&gt;
<p>&lt;a id="chhoto_redirect_method"&gt;&lt;/a&gt;</p>
<h3><code>CHHOTO_REDIRECT_METHOD</code> #</h3>
&lt;!-- prettier-ignore-end --&gt;
<p>Sets which redirection is used when a shortlink is resolved.</p>
<p>Can be set to <code>TEMPORARY</code> or <code>PERMANENT</code>, which will enable Temporary 307 or Permanent 308 redirects. Any other value
will be ignored, and a default of <code>PERMANENT</code> will be used.</p>
<h3><code>CHHOTO_SLUG_STYLE</code></h3>
<p>Sets the style of slug used when auto-generating shortlinks.</p>
<p>Can be set to either <code>Pair</code> or <code>UID</code>. Any other value will be ignored, and a default value of <code>Pair</code> will be used.
In pair mode, adjective-name pairs are used for auto-generated links e.g. <code>gifted-ramanujan</code>. In UID mode, a randomly
generated slug is used.</p>
<h3><code>CHHOTO_SLUG_LENGTH</code></h3>
<p>If UID slugs are enabled, the length of the slug can be set using this. A minimum of 4 is supported, and it defaults to 16.
If you intend to have more than a few thousand shortlinks, it's strongly recommended that you use the UID
<a href="#chhoto_slug_style"><code>CHHOTO_SLUG_STYLE</code></a> with a <a href="#chhoto_slug_length"><code>CHHOTO_SLUG_LENGTH</code></a> of 16 or more.</p>
<h3><code>CHHOTO_TRY_LONGER_SLUG</code></h3>
<p>If you do choose to use a short UID despite anticipating collisions, it's recommended that you set this to <code>True</code>.
In the event of a collision, this variable will result in a single retry attempt using a UID four digits longer than
<a href="#chhoto_slug_length"><code>CHHOTO_SLUG_LENGTH</code></a>. For adjective-name slugs, a four digit suffix is added e.g.
<code>gifted-ramanujan-1729</code>.</p>
<p><em>Note: If not set, one retry will be attempted, just like adjective-name slugs. But it would use the same slug length.</em></p>
<h3><code>CHHOTO_LISTEN_ADDRESS</code></h3>
<p>The address Chhoto URL will bind to. Defaults to <code>0.0.0.0</code>.</p>
<p>Take a look at <a href="https://docs.rs/actix-web/4.11.0/actix_web/struct.HttpServer.html#method.bind">this page</a>
for supported values and potential consequences. Changing <a href="#chhoto_listen_address"><code>CHHOTO_LISTEN_ADDRESS</code></a> is not
recommended if using docker.
If running locally, you may not be able to access Chhoto URL depending on your OS, browser configs etc. In that case,
try setting <code>::</code> as the listen address to also support IPV6.</p>
<h3><code>CHHOTO_LISTEN_PORT</code></h3>
<p>The port Chhoto URL will listen to. Defaults to <code>4567</code>.</p>
<h3><code>CHHOTO_ALLOW_CAPITAL_LETTERS</code></h3>
<p>If you want to use capital letters in the shortlink, set the <a href="#chhoto_allow_capital_letters"><code>CHHOTO_ALLOW_CAPITAL_LETTERS</code></a>
variable to <code>True</code>. Any other value is ignored.</p>
<p>This will also allow capital letters in UID slugs, if those are enabled. It has no effect for adjective-name slugs.</p>
&lt;!-- prettier-ignore-start --&gt;
<p>&lt;a id="chhoto_hash_algorithm"&gt;&lt;/a&gt;</p>
<h3><code>CHHOTO_HASH_ALGORITHM</code> #</h3>
&lt;!-- prettier-ignore-end --&gt;
<p>If you want to provided hashed password and API Key, name a supported algorithm here. For now, the supported
values are: <code>Argon2</code>. More algorithms may be added later. Unsupported values are ignored.</p>
<p>It is highly recommended that you use <code>Argon2</code> hashes for security.</p>
<p><em>Note: If using a compose file, make sure to escape $ by $$.</em></p>
<p><em>Warning: It will add some latency to some of your requests and use more resources in general.</em></p>
<p>Recommended command for hashing:</p>
<pre class="language-bash"><a-f>echo</a-f> <a-co>-n</a-co> <a-o>&lt;</a-o>password<a-o>&gt;</a-o> <a-o>|</a-o> argon2 <a-o>&lt;</a-o>salt<a-o>&gt;</a-o> -id -t 3 -m 16 -l 32 -e</pre>
<p>You may also use online tools for this step.</p>
<h3><code>CHHOTO_PUBLIC_MODE</code></h3>
<p>To enable public mode, set <a href="#chhoto_public_mode"><code>CHHOTO_PUBLIC_MODE</code></a> to <code>Enable</code>. With this, anyone will be able to add
links. Listing existing links or deleting links will need admin access using the password. Any other values are
ignored.</p>
<h3><code>CHHOTO_PUBLIC_MODE_EXPIRY_DELAY</code></h3>
<p>If <a href="#chhoto_public_mode"><code>CHHOTO_PUBLIC_MODE</code></a> is enabled, and <a href="#chhoto_public_mode_expiry_delay"><code>CHHOTO_PUBLIC_MODE_EXPIRY_DELAY</code></a>
is set to a positive value, submitted links will expire in that given time (in seconds). The user can still
choose a shorter expiry delay.</p>
<p>It will have no effect for a logged in user i.e. the admin.</p>
<h3><code>CHHOTO_DISABLE_FRONTEND</code></h3>
<p>Set this to <code>True</code> to completely disable the frontend.</p>
<h3><code>CHHOTO_CUSTOM_SITE_TITLE</code></h3>
<p>Use this to set a custom site title. If "Custom Title" is provided, the served title will be "Custom Title - Powered by Chhoto URL".
The title used on the page will be simply "Custom Title". Using custom favicon is possible by mounting favicon files in the correct
locations (<code>/app/frontend/base/assets/favicon*</code>). For more customization, please make use of
<a href="#chhoto_custom_landing_directory"><code>CHHOTO_CUSTOM_LANDING_DIRECTORY</code></a>.</p>
<h3><code>CHHOTO_CUSTOM_LANDING_DIRECTORY</code></h3>
<p>If you want to serve a custom landing page, put all your site related files, along with a valid <code>index.html</code> file in a
directory, and set this to the path of the directory. If using docker, you need to first
mount the directory inside the container. The admin page will then be located at <code>/admin/manage</code>.</p>
<p><em>Warning: Put anything except the <code>index.html</code> file inside some directory, because naked filenames will be treated
as shortlinks.</em></p>
<h3><code>CHHOTO_CACHE_CONTROL_HEADER</code></h3>
<p>By default, the server sends no Cache-Control headers. You can set custom headers here
to send your desired headers. It must be a comma separated list of valid
<a href="https://datatracker.ietf.org/docs/html/rfc7234#section-5.2">RFC 7234 §5.2</a> headers. For example,
you can set it to <code>no-cache, private</code> to disable caching. It might help during testing if
served through a proxy.</p>
<h3><code>CHHOTO_FRONTEND_PAGE_SIZE</code></h3>
<p>This can be used to set the number of items shown per page in the frontend. This does not have any effect on the backend code.
Defaults to 10.</p>
<h3><code>CHHOTO_EXTRA_PROTOCOLS</code></h3>
<p>Use this to allow extra protocols for longlinks. By default, only <code>http</code>, <code>https</code>, <code>ftp</code>, and <code>magnet</code> links are allowed. It should be a comma
separated list e.g. <code>ftps,obsidian</code>. Malformed protocols will be skipped.</p>
<h3><code>RUST_LOG</code></h3>
<p>It controls the level of logging.</p>
<p>Logging is done using the <code>env_logger</code> crate. No personal information of the end user is ever logged, nor will it ever supported. The
logging level can be controlled using the <a href="https://docs.rs/env_logger/latest/env_logger/#enabling-logging"><code>RUST_LOG</code></a> variable. By default,
the value is set to the following.</p>
<pre>warn,chhoto_url=info,actix_session::middleware=error
</pre>
<p>If you want a bit more logging, try this.</p>
<pre>warn,chhoto_url=debug,actix_session::middleware=error
</pre>
<h2>Note of eventual deprecation of old config options</h2>
<p>The config variables used to have different names up to commit 228eb7a, after which they were changed to adhere to norms for config variable
naming. The old names will keep working for now, but <em>it is highly recommended to migrate to the new variable names</em> as support for these
will eventually be dropped in some future major release.</p>
<h2>Backups</h2>
<p>Database backups are created during init, along with daily backups taken between 3am and 4am. The backup files are created in a directory
called <code>backups</code>, which is in the same directory as the database file. The backups are SQLite files, and are named using the original
database file name, and backup type. Daily backups have <code>.daily1</code>, <code>.daily2</code> etc. as the suffix, whereas the init backups have
<code>.init1</code>, <code>.init2</code> etc. as the suffix.</p>
<p>Backups are automatically purged, keeping up to 3 init backups, and 7 daily backups at any time. It's still recommended to keep your own
backups on top of these.</p>
<h2>Container Security Hardening</h2>
<p>Due to its design, Chhoto URL can work with basically no permissions. You can use the <code>scratch</code> image with the following Docker options for
maximum security. Similar options are available for Podman and other container engines.</p>
<ul>
<li><a href="https://docs.docker.com/engine/security/rootless">Run rootless</a></li>
<li><a href="https://docs.docker.com/reference/compose-file/services/#cap_drop">Drop all capabilities</a>: <code>cap_drop: ALL</code></li>
<li><a href="https://docs.docker.com/reference/compose-file/services/#read_only">Read only mode</a>: Make sure to mount a named volume, or create a bind
mount at <code>/data</code>. Also, mount a <a href="https://docs.docker.com/reference/compose-file/services/#tmpfs"><code>tmpfs</code></a> at <code>/app/frontend/final</code>.</li>
<li><a href="https://docs.docker.com/reference/compose-file/services/#security_opt">Deny privileges to processes</a></li>
</ul>
<h2>Deploying in your Kubernetes cluster with Helm</h2>
<p>The helm values are very sparse to keep it simple. If you need more values to be variable, feel free to adjust.</p>
<p>The PVC allocates 100Mi and the PV is using a host path volume.</p>
<p>The helm chart assumes you have <a href="https://github.com/jetstack/cert-manager">cert manager</a> deployed to have TLS
certificates managed easily in your cluster. Feel free to remove the issuer and adjust the ingress if you're on
AWS with EKS for example. To install cert-manager, I recommend using the
<a href="https://cert-manager.io/docs/installation/kubectl/">"kubectl apply" way</a> to install cert-manager.</p>
<p>To get started, <code>cp deploy/helm-chart/values.yaml deploy/helm-chart/my-values.yaml</code> and adjust <code>password</code>, <code>fqdn</code>
and <code>letsencryptmail</code> in your new <code>my-values.yaml</code>, then just run.</p>
<p><a href="/fork/chhoto-url/ref/unicode/tree/deploy/helm-chart/">All the related files can be found here.</a></p>
<pre class="language-bash"><a-f>cd</a-f> helm-chart
<a-f>helm</a-f> upgrade <a-co>--install</a-co> chhoto-url . <a-co>-n</a-co> chhoto-url <a-co>--create-namespace</a-co> <a-co>-f</a-co> my-values.yaml</pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-c>&lt;!-- SPDX-FileCopyrightText: 2023-2026 Sayantan Santra &lt;sayantan.santra689@gmail.com&gt; --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"><a-c>&lt;!-- SPDX-License-Identifier: MIT --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text"><a-p>#</a-p> <a-tt>Installation and Configuration</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text"><a-p>##</a-p> <a-tt>Using Docker Compose or Podman Quadlets (Recommended method)</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text">The repository includes a [sample `compose.yaml` file](../deploy/compose.yaml). It contains</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text">everything needed for a basic deployment.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text">Starting with version 6.2.6, OCI images are built by a GitHub Actions workflow.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text">You can [check the workflow for yourself](../.github/workflows/test-and-release.yml) to make sure that nothing silly is going on.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text">The container images come in two flavors. The default image is built from [`scratch`](https://hub.docker.com/_/scratch),</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text">and is as light as possible. The tags with the `-alpine` suffix are built on top of [`alpine`](https://hub.docker.com/_/alpine).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text">These images are slightly larger, but include basic Unix tools that can be useful for debugging or for inspecting the container</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text">interactively. The `dev` tags are always built on top of `alpine` and are intended for testing only; **do not use these for production</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text">workloads.** The tags `latest` and `scratch` are synonymous, as are `latest-alpine` and `alpine`.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text">All of these images are available both on the Docker Hub (recommended) and GHCR, except for `dev` builds, which are published</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text">only to GHCR. They are built for Linux on the `linux/amd64`, `linux/arm64`, `linux/arm/v7`, and `linux/riscv64` architectures.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text">The images should also work with Podman and other OCI-compatible container engines.</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text">You can use the provided `compose` file as a base, modifying it as needed. Run it with</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"><a-p>docker compose up -d</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>If you&#39;re using a custom location for the [`CHHOTO_DB_URL`](#chhoto_db_url), and using WAL mode, make sure to mount a whole</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>directory instead of a folder. If this is not done, there will be a low, but non-zero chance of data corruption.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>It should be possible to run Chhoto URL with pretty much anything that supports OCI images e.g. `docker`, `podman quadlets`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>(the repo contains a sample [`chhoto-url.container`](../deploy/chhoto-url.container) file for using with `quadlets`.) etc. Official</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>support is only provided for `docker` and `podman`, but it should be trivial to convert the `compose.yaml` file to other formats.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>If you need help, feel free to open a discussion.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L37" href="#L37">37</a><span class="code-text"><a-p>## </a-p><a-tt>Building and running with Docker</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L38" href="#L38">38</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L39" href="#L39">39</a><span class="code-text"><a-p>### </a-p><a-tt>`docker run` method</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L40" href="#L40">40</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L41" href="#L41">41</a><span class="code-text"><a-p>0. (Only if you really want to) Build the image for the default `x86_64-unknown-linux-musl` target:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L42" href="#L42">42</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L43" href="#L43">43</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L44" href="#L44">44</a><span class="code-text"><a-p>docker build -f build/Containerfile . -t chhoto-url</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L45" href="#L45">45</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L46" href="#L46">46</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L47" href="#L47">47</a><span class="code-text"><a-p>For building on `arm64`, `arm/v7`, or `riscv64`, use the following:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L48" href="#L48">48</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L49" href="#L49">49</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L50" href="#L50">50</a><span class="code-text"><a-p>docker build -f build/Containerfile . -t chhoto-url --build-arg target=&lt;desired-target&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L51" href="#L51">51</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L52" href="#L52">52</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L53" href="#L53">53</a><span class="code-text"><a-p>Make sure that the desired target is a `musl` one, since the docker image is built from `scratch`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L54" href="#L54">54</a><span class="code-text"><a-p>For cross-compilation, take a look at the `Makefile`. It has instructions to build the architectures</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L55" href="#L55">55</a><span class="code-text"><a-p>mentioned above., For any other architectures, open a discussion, and I&#39;ll try to help you out.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L56" href="#L56">56</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L57" href="#L57">57</a><span class="code-text"><a-p>1. Run the image</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L58" href="#L58">58</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L59" href="#L59">59</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L60" href="#L60">60</a><span class="code-text"><a-p>docker run -p 4567:4567 \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L61" href="#L61">61</a><span class="code-text"><a-p>    -f build/Containerfile \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L62" href="#L62">62</a><span class="code-text"><a-p>    -e CHHOTO_PASSWORD=&quot;password&quot; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L63" href="#L63">63</a><span class="code-text"><a-p>    -d chhoto-url:alpine</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L64" href="#L64">64</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L65" href="#L65">65</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L66" href="#L66">66</a><span class="code-text"><a-p>1.a Make the database file available to host (optional)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L67" href="#L67">67</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L68" href="#L68">68</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L69" href="#L69">69</a><span class="code-text"><a-p>touch ./urls.sqlite</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L70" href="#L70">70</a><span class="code-text"><a-p>docker run -p 4567:4567 \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L71" href="#L71">71</a><span class="code-text"><a-p>    -f build/Containerfile</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L72" href="#L72">72</a><span class="code-text"><a-p>    -e CHHOTO_PASSWORD=&quot;password&quot; \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L73" href="#L73">73</a><span class="code-text"><a-p>    -v ./data:/data \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L74" href="#L74">74</a><span class="code-text"><a-p>    -e CHHOTO_DB_URL=/data/urls.sqlite \</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L75" href="#L75">75</a><span class="code-text"><a-p>    -d chhoto-url:alpine</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L76" href="#L76">76</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L77" href="#L77">77</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L78" href="#L78">78</a><span class="code-text"><a-p>_Note: All of this pretty much works exactly the same if you replace `docker` with `podman`. In fact,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L79" href="#L79">79</a><span class="code-text"><a-p>that&#39;s what I use for testing. A sample file for podman quadlets is provided at</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L80" href="#L80">80</a><span class="code-text"><a-p>[`chhoto-url.container`](../deploy/chhoto-url.container)_</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L81" href="#L81">81</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L82" href="#L82">82</a><span class="code-text"><a-p>## </a-p><a-tt>Configuration options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L83" href="#L83">83</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L84" href="#L84">84</a><span class="code-text"><a-p>All the configuration is done using environmental variables. Here&#39;s a link of all supported ones. Please take</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L85" href="#L85">85</a><span class="code-text"><a-p>a look at the ones marked with a `#` as those are important, especially [`CHHOTO_SQLITE_USE_WAL_MODE`](#chhoto_sqlite_use_wal_mode).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L86" href="#L86">86</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L87" href="#L87">87</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-start --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L88" href="#L88">88</a><span class="code-text"><a-p>&lt;a id=&quot;chhoto_db_url&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L89" href="#L89">89</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_DB_URL` \#</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L90" href="#L90">90</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-end --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L91" href="#L91">91</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L92" href="#L92">92</a><span class="code-text"><a-p>Location for the database file. Take a look at [`CHHOTO_SQLITE_USE_WAL_MODE`](#chhoto_sqlite_use_wal_mode) before you change it. Defaults to</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L93" href="#L93">93</a><span class="code-text"><a-p>`urls.sqlite`. It is highly recommended that you mount a named volume or directory at a location like `/data` and</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L94" href="#L94">94</a><span class="code-text"><a-p>use something like `/data/urls.sqlite` here.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L95" href="#L95">95</a><span class="code-text"><a-p>(Of course, the actual names being used don&#39;t really matter.)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L96" href="#L96">96</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L97" href="#L97">97</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-start --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L98" href="#L98">98</a><span class="code-text"><a-p>&lt;a id=&quot;chhoto_password&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L99" href="#L99">99</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_PASSWORD` \#</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L100" href="#L100">100</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-end --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L101" href="#L101">101</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L102" href="#L102">102</a><span class="code-text"><a-p>Provide a secure password. If kept empty, anyone can access the website. Note that password is not encrypted in</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L103" href="#L103">103</a><span class="code-text"><a-p>transport, so it&#39;s recommended to use a reverse proxy like `caddy` or `nginx`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L104" href="#L104">104</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L105" href="#L105">105</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-start --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L106" href="#L106">106</a><span class="code-text"><a-p>&lt;a id=&quot;chhoto_site_url&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L107" href="#L107">107</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_SITE_URL` \#</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L108" href="#L108">108</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-end --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L109" href="#L109">109</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L110" href="#L110">110</a><span class="code-text"><a-p>Change this to your public-facing URL. This is optional, as the link will work at any URL as long as Chhoto URL</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L111" href="#L111">111</a><span class="code-text"><a-p>is accessible there. This mostly enhances the frontend experience, as copying to clipboard, QR code generation will</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L112" href="#L112">112</a><span class="code-text"><a-p>use it if available.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L113" href="#L113">113</a><span class="code-text"><a-p>Do not surround it using quotes. If you have any unicode characters, please use the punycode. It&#39;ll be automatically</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L114" href="#L114">114</a><span class="code-text"><a-p>converted to the correct unicode in the frontend.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L115" href="#L115">115</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L116" href="#L116">116</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_API_KEY`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L117" href="#L117">117</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L118" href="#L118">118</a><span class="code-text"><a-p>Provide a secure API key. It&#39;ll be checked at start for security. If the API key is considered weak, a strong API</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L119" href="#L119">119</a><span class="code-text"><a-p>key will be generated and printed in the logs, but the weak one will be used for the time being.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L120" href="#L120">120</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L121" href="#L121">121</a><span class="code-text"><a-p>Example Linux command for generating a secure API key: `tr -dc A-Za-z0-9 &lt;/dev/urandom | head -c 128`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L122" href="#L122">122</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L123" href="#L123">123</a><span class="code-text"><a-p>If no API key is provided, the website will still work, but it&#39;ll be a significantly worse experience if you try</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L124" href="#L124">124</a><span class="code-text"><a-p>to use Chhoto URL from the CLI.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L125" href="#L125">125</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L126" href="#L126">126</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-start --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L127" href="#L127">127</a><span class="code-text"><a-p>&lt;a id=&quot;chhoto_sqlite_use_wal_mode&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L128" href="#L128">128</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_SQLITE_USE_WAL_MODE` \#</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L129" href="#L129">129</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-end --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L130" href="#L130">130</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L131" href="#L131">131</a><span class="code-text"><a-p>If set to `True`, enables [`WAL` journal mode](https://sqlite.org/wal.html). Any other value is ignored.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L132" href="#L132">132</a><span class="code-text"><a-p>It&#39;s highly recommended that you enable it, but make sure that you mount either a whole directory, or a named</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L133" href="#L133">133</a><span class="code-text"><a-p>volume, and have the database inside it. DO NOT mount a single file, as there will be a small chance of partial</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L134" href="#L134">134</a><span class="code-text"><a-p>data loss in that case.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L135" href="#L135">135</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L136" href="#L136">136</a><span class="code-text"><a-p>If this is enabled, there&#39;ll be a significant boost in performance under high load, since write will no longer block reads.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L137" href="#L137">137</a><span class="code-text"><a-p>Otherwise, `DELETE` journal mode is used by default, along with [`EXTRA` synchronous](https://sqlite.org/pragma.html#pragma_synchronous)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L138" href="#L138">138</a><span class="code-text"><a-p>pragma. In `WAL` mode, `FULL` synchronous pragma is used instead.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L139" href="#L139">139</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L140" href="#L140">140</a><span class="code-text"><a-p>In both cases, we have full ACID compliance, but it does cost a bit of performance. If you expect to see high throughput (in the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L141" href="#L141">141</a><span class="code-text"><a-p>order of hundreds of read/writes per second), take a look at the [`CHHOTO_SQLITE_ENSURE_ACID`](#chhoto_sqlite_ensure_acid) configuration option.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L142" href="#L142">142</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L143" href="#L143">143</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_SQLITE_ENSURE_ACID`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L144" href="#L144">144</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L145" href="#L145">145</a><span class="code-text"><a-p>By default, the database is</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L146" href="#L146">146</a><span class="code-text"><a-p>[ACID (i.e. Atomic, Consistent, Isolated, and Durable)](https://www.slingacademy.com/article/acid-properties-in-sqlite-why-they-matter).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L147" href="#L147">147</a><span class="code-text"><a-p>If you&#39;d like to let go of durability for an increase in throughput, set this to `False`. Any other value will be ignored.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L148" href="#L148">148</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L149" href="#L149">149</a><span class="code-text"><a-p>This is done by setting the [synchronous pragma](https://sqlite.org/pragma.html#pragma_synchronous) to `FULL` in `WAL`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L150" href="#L150">150</a><span class="code-text"><a-p>[journal mode](https://sqlite.org/pragma.html#pragma_journal_mode), and to `EXTRA` in `DELETE` journal mode.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L151" href="#L151">151</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L152" href="#L152">152</a><span class="code-text"><a-p>_Note: There might be partial data loss only in case of system failure or power loss. Durability is maintained across application</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L153" href="#L153">153</a><span class="code-text"><a-p>crashes. If you do have data loss, you should only lose the data stored after the last sync with the database file. So, under normal</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L154" href="#L154">154</a><span class="code-text"><a-p>loads, you shouldn&#39;t lose any data anyway. But this is a real thing that can technically happen._</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L155" href="#L155">155</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L156" href="#L156">156</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_DISABLE_BACKUPS`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L157" href="#L157">157</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L158" href="#L158">158</a><span class="code-text"><a-p>Set this to `True` to disable the automated database backups. Only do this if you have another strategy for backups, or you truly don&#39;t</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L159" href="#L159">159</a><span class="code-text"><a-p>care about your data. **You&#39;ve been warned.**</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L160" href="#L160">160</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L161" href="#L161">161</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-start --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L162" href="#L162">162</a><span class="code-text"><a-p>&lt;a id=&quot;chhoto_redirect_method&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L163" href="#L163">163</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_REDIRECT_METHOD` \#</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L164" href="#L164">164</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-end --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L165" href="#L165">165</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L166" href="#L166">166</a><span class="code-text"><a-p>Sets which redirection is used when a shortlink is resolved.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L167" href="#L167">167</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L168" href="#L168">168</a><span class="code-text"><a-p>Can be set to `TEMPORARY` or `PERMANENT`, which will enable Temporary 307 or Permanent 308 redirects. Any other value</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L169" href="#L169">169</a><span class="code-text"><a-p>will be ignored, and a default of `PERMANENT` will be used.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L170" href="#L170">170</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L171" href="#L171">171</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_SLUG_STYLE`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L172" href="#L172">172</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L173" href="#L173">173</a><span class="code-text"><a-p>Sets the style of slug used when auto-generating shortlinks.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L174" href="#L174">174</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L175" href="#L175">175</a><span class="code-text"><a-p>Can be set to either `Pair` or `UID`. Any other value will be ignored, and a default value of `Pair` will be used.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L176" href="#L176">176</a><span class="code-text"><a-p>In pair mode, adjective-name pairs are used for auto-generated links e.g. `gifted-ramanujan`. In UID mode, a randomly</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L177" href="#L177">177</a><span class="code-text"><a-p>generated slug is used.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L178" href="#L178">178</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L179" href="#L179">179</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_SLUG_LENGTH`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L180" href="#L180">180</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L181" href="#L181">181</a><span class="code-text"><a-p>If UID slugs are enabled, the length of the slug can be set using this. A minimum of 4 is supported, and it defaults to 16.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L182" href="#L182">182</a><span class="code-text"><a-p>If you intend to have more than a few thousand shortlinks, it&#39;s strongly recommended that you use the UID</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L183" href="#L183">183</a><span class="code-text"><a-p>[`CHHOTO_SLUG_STYLE`](#chhoto_slug_style) with a [`CHHOTO_SLUG_LENGTH`](#chhoto_slug_length) of 16 or more.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L184" href="#L184">184</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L185" href="#L185">185</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_TRY_LONGER_SLUG`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L186" href="#L186">186</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L187" href="#L187">187</a><span class="code-text"><a-p>If you do choose to use a short UID despite anticipating collisions, it&#39;s recommended that you set this to `True`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L188" href="#L188">188</a><span class="code-text"><a-p>In the event of a collision, this variable will result in a single retry attempt using a UID four digits longer than</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L189" href="#L189">189</a><span class="code-text"><a-p>[`CHHOTO_SLUG_LENGTH`](#chhoto_slug_length). For adjective-name slugs, a four digit suffix is added e.g.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L190" href="#L190">190</a><span class="code-text"><a-p>`gifted-ramanujan-1729`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L191" href="#L191">191</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L192" href="#L192">192</a><span class="code-text"><a-p>_Note: If not set, one retry will be attempted, just like adjective-name slugs. But it would use the same slug length._</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L193" href="#L193">193</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L194" href="#L194">194</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_LISTEN_ADDRESS`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L195" href="#L195">195</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L196" href="#L196">196</a><span class="code-text"><a-p>The address Chhoto URL will bind to. Defaults to `0.0.0.0`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L197" href="#L197">197</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L198" href="#L198">198</a><span class="code-text"><a-p>Take a look at [this page](https://docs.rs/actix-web/4.11.0/actix_web/struct.HttpServer.html#method.bind)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L199" href="#L199">199</a><span class="code-text"><a-p>for supported values and potential consequences. Changing [`CHHOTO_LISTEN_ADDRESS`](#chhoto_listen_address) is not</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L200" href="#L200">200</a><span class="code-text"><a-p>recommended if using docker.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L201" href="#L201">201</a><span class="code-text"><a-p>If running locally, you may not be able to access Chhoto URL depending on your OS, browser configs etc. In that case,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L202" href="#L202">202</a><span class="code-text"><a-p>try setting `::` as the listen address to also support IPV6.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L203" href="#L203">203</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L204" href="#L204">204</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_LISTEN_PORT`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L205" href="#L205">205</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L206" href="#L206">206</a><span class="code-text"><a-p>The port Chhoto URL will listen to. Defaults to `4567`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L207" href="#L207">207</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L208" href="#L208">208</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_ALLOW_CAPITAL_LETTERS`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L209" href="#L209">209</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L210" href="#L210">210</a><span class="code-text"><a-p>If you want to use capital letters in the shortlink, set the [`CHHOTO_ALLOW_CAPITAL_LETTERS`](#chhoto_allow_capital_letters)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L211" href="#L211">211</a><span class="code-text"><a-p>variable to `True`. Any other value is ignored.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L212" href="#L212">212</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L213" href="#L213">213</a><span class="code-text"><a-p>This will also allow capital letters in UID slugs, if those are enabled. It has no effect for adjective-name slugs.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L214" href="#L214">214</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L215" href="#L215">215</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-start --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L216" href="#L216">216</a><span class="code-text"><a-p>&lt;a id=&quot;chhoto_hash_algorithm&quot;&gt;&lt;/a&gt;</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L217" href="#L217">217</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_HASH_ALGORITHM` \#</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L218" href="#L218">218</a><span class="code-text"><a-c>&lt;!-- prettier-ignore-end --&gt;</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L219" href="#L219">219</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L220" href="#L220">220</a><span class="code-text"><a-p>If you want to provided hashed password and API Key, name a supported algorithm here. For now, the supported</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L221" href="#L221">221</a><span class="code-text"><a-p>values are: `Argon2`. More algorithms may be added later. Unsupported values are ignored.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L222" href="#L222">222</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L223" href="#L223">223</a><span class="code-text"><a-p>It is highly recommended that you use `Argon2` hashes for security.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L224" href="#L224">224</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L225" href="#L225">225</a><span class="code-text"><a-p>_Note: If using a compose file, make sure to escape $ by $$._</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L226" href="#L226">226</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L227" href="#L227">227</a><span class="code-text"><a-p>_Warning: It will add some latency to some of your requests and use more resources in general._</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L228" href="#L228">228</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L229" href="#L229">229</a><span class="code-text"><a-p>Recommended command for hashing:</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L230" href="#L230">230</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L231" href="#L231">231</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L232" href="#L232">232</a><span class="code-text"><a-p>echo </a-p><a-co>-n</a-co><a-p> </a-p><a-o>&lt;</a-o><a-p>password</a-p><a-o>&gt;</a-o><a-p> </a-p><a-o>|</a-o><a-p> argon2 </a-p><a-o>&lt;</a-o><a-p>salt</a-p><a-o>&gt;</a-o><a-p> -id -t 3 -m 16 -l 32 -e</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L233" href="#L233">233</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L234" href="#L234">234</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L235" href="#L235">235</a><span class="code-text"><a-p>You may also use online tools for this step.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L236" href="#L236">236</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L237" href="#L237">237</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_PUBLIC_MODE`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L238" href="#L238">238</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L239" href="#L239">239</a><span class="code-text"><a-p>To enable public mode, set [`CHHOTO_PUBLIC_MODE`](#chhoto_public_mode) to `Enable`. With this, anyone will be able to add</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L240" href="#L240">240</a><span class="code-text"><a-p>links. Listing existing links or deleting links will need admin access using the password. Any other values are</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L241" href="#L241">241</a><span class="code-text"><a-p>ignored.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L242" href="#L242">242</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L243" href="#L243">243</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_PUBLIC_MODE_EXPIRY_DELAY`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L244" href="#L244">244</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L245" href="#L245">245</a><span class="code-text"><a-p>If [`CHHOTO_PUBLIC_MODE`](#chhoto_public_mode) is enabled, and [`CHHOTO_PUBLIC_MODE_EXPIRY_DELAY`](#chhoto_public_mode_expiry_delay)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L246" href="#L246">246</a><span class="code-text"><a-p>is set to a positive value, submitted links will expire in that given time (in seconds). The user can still</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L247" href="#L247">247</a><span class="code-text"><a-p>choose a shorter expiry delay.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L248" href="#L248">248</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L249" href="#L249">249</a><span class="code-text"><a-p>It will have no effect for a logged in user i.e. the admin.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L250" href="#L250">250</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L251" href="#L251">251</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_DISABLE_FRONTEND`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L252" href="#L252">252</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L253" href="#L253">253</a><span class="code-text"><a-p>Set this to `True` to completely disable the frontend.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L254" href="#L254">254</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L255" href="#L255">255</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_CUSTOM_SITE_TITLE`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L256" href="#L256">256</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L257" href="#L257">257</a><span class="code-text"><a-p>Use this to set a custom site title. If &quot;Custom Title&quot; is provided, the served title will be &quot;Custom Title - Powered by Chhoto URL&quot;.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L258" href="#L258">258</a><span class="code-text"><a-p>The title used on the page will be simply &quot;Custom Title&quot;. Using custom favicon is possible by mounting favicon files in the correct</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L259" href="#L259">259</a><span class="code-text"><a-p>locations (`/app/frontend/base/assets/favicon*`). For more customization, please make use of</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L260" href="#L260">260</a><span class="code-text"><a-p>[`CHHOTO_CUSTOM_LANDING_DIRECTORY`](#chhoto_custom_landing_directory).</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L261" href="#L261">261</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L262" href="#L262">262</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_CUSTOM_LANDING_DIRECTORY`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L263" href="#L263">263</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L264" href="#L264">264</a><span class="code-text"><a-p>If you want to serve a custom landing page, put all your site related files, along with a valid `index.html` file in a</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L265" href="#L265">265</a><span class="code-text"><a-p>directory, and set this to the path of the directory. If using docker, you need to first</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L266" href="#L266">266</a><span class="code-text"><a-p>mount the directory inside the container. The admin page will then be located at `/admin/manage`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L267" href="#L267">267</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L268" href="#L268">268</a><span class="code-text"><a-p>_Warning: Put anything except the `index.html` file inside some directory, because naked filenames will be treated</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L269" href="#L269">269</a><span class="code-text"><a-p>as shortlinks._</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L270" href="#L270">270</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L271" href="#L271">271</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_CACHE_CONTROL_HEADER`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L272" href="#L272">272</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L273" href="#L273">273</a><span class="code-text"><a-p>By default, the server sends no Cache-Control headers. You can set custom headers here</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L274" href="#L274">274</a><span class="code-text"><a-p>to send your desired headers. It must be a comma separated list of valid</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L275" href="#L275">275</a><span class="code-text"><a-p>[RFC 7234 §5.2](https://datatracker.ietf.org/docs/html/rfc7234#section-5.2) headers. For example,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L276" href="#L276">276</a><span class="code-text"><a-p>you can set it to `no-cache, private` to disable caching. It might help during testing if</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L277" href="#L277">277</a><span class="code-text"><a-p>served through a proxy.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L278" href="#L278">278</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L279" href="#L279">279</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_FRONTEND_PAGE_SIZE`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L280" href="#L280">280</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L281" href="#L281">281</a><span class="code-text"><a-p>This can be used to set the number of items shown per page in the frontend. This does not have any effect on the backend code.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L282" href="#L282">282</a><span class="code-text"><a-p>Defaults to 10.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L283" href="#L283">283</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L284" href="#L284">284</a><span class="code-text"><a-p>### </a-p><a-tt>`CHHOTO_EXTRA_PROTOCOLS`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L285" href="#L285">285</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L286" href="#L286">286</a><span class="code-text"><a-p>Use this to allow extra protocols for longlinks. By default, only `http`, `https`, `ftp`, and `magnet` links are allowed. It should be a comma</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L287" href="#L287">287</a><span class="code-text"><a-p>separated list e.g. `ftps,obsidian`. Malformed protocols will be skipped.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L288" href="#L288">288</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L289" href="#L289">289</a><span class="code-text"><a-p>### </a-p><a-tt>`RUST_LOG`</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L290" href="#L290">290</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L291" href="#L291">291</a><span class="code-text"><a-p>It controls the level of logging.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L292" href="#L292">292</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L293" href="#L293">293</a><span class="code-text"><a-p>Logging is done using the `env_logger` crate. No personal information of the end user is ever logged, nor will it ever supported. The</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L294" href="#L294">294</a><span class="code-text"><a-p>logging level can be controlled using the [`RUST_LOG`](https://docs.rs/env_logger/latest/env_logger/#enabling-logging) variable. By default,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L295" href="#L295">295</a><span class="code-text"><a-p>the value is set to the following.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L296" href="#L296">296</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L297" href="#L297">297</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L298" href="#L298">298</a><span class="code-text"><a-p>warn,chhoto_url=info,actix_session::middleware=error</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L299" href="#L299">299</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L300" href="#L300">300</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L301" href="#L301">301</a><span class="code-text"><a-p>If you want a bit more logging, try this.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L302" href="#L302">302</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L303" href="#L303">303</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L304" href="#L304">304</a><span class="code-text"><a-p>warn,chhoto_url=debug,actix_session::middleware=error</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L305" href="#L305">305</a><span class="code-text"><a-p>```</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L306" href="#L306">306</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L307" href="#L307">307</a><span class="code-text"><a-p>## </a-p><a-tt>Note of eventual deprecation of old config options</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L308" href="#L308">308</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L309" href="#L309">309</a><span class="code-text"><a-p>The config variables used to have different names up to commit 228eb7a, after which they were changed to adhere to norms for config variable</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L310" href="#L310">310</a><span class="code-text"><a-p>naming. The old names will keep working for now, but _it is highly recommended to migrate to the new variable names_ as support for these</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L311" href="#L311">311</a><span class="code-text"><a-p>will eventually be dropped in some future major release.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L312" href="#L312">312</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L313" href="#L313">313</a><span class="code-text"><a-p>## </a-p><a-tt>Backups</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L314" href="#L314">314</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L315" href="#L315">315</a><span class="code-text"><a-p>Database backups are created during init, along with daily backups taken between 3am and 4am. The backup files are created in a directory</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L316" href="#L316">316</a><span class="code-text"><a-p>called `backups`, which is in the same directory as the database file. The backups are SQLite files, and are named using the original</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L317" href="#L317">317</a><span class="code-text"><a-p>database file name, and backup type. Daily backups have `.daily1`, `.daily2` etc. as the suffix, whereas the init backups have</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L318" href="#L318">318</a><span class="code-text"><a-p>`.init1`, `.init2` etc. as the suffix.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L319" href="#L319">319</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L320" href="#L320">320</a><span class="code-text"><a-p>Backups are automatically purged, keeping up to 3 init backups, and 7 daily backups at any time. It&#39;s still recommended to keep your own</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L321" href="#L321">321</a><span class="code-text"><a-p>backups on top of these.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L322" href="#L322">322</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L323" href="#L323">323</a><span class="code-text"><a-p>## </a-p><a-tt>Container Security Hardening</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L324" href="#L324">324</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L325" href="#L325">325</a><span class="code-text"><a-p>Due to its design, Chhoto URL can work with basically no permissions. You can use the `scratch` image with the following Docker options for</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L326" href="#L326">326</a><span class="code-text"><a-p>maximum security. Similar options are available for Podman and other container engines.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L327" href="#L327">327</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L328" href="#L328">328</a><span class="code-text"><a-p>- [Run rootless](https://docs.docker.com/engine/security/rootless)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L329" href="#L329">329</a><span class="code-text"><a-p>- [Drop all capabilities](https://docs.docker.com/reference/compose-file/services/#cap_drop): `cap_drop: ALL`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L330" href="#L330">330</a><span class="code-text"><a-p>- [Read only mode](https://docs.docker.com/reference/compose-file/services/#read_only): Make sure to mount a named volume, or create a bind</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L331" href="#L331">331</a><span class="code-text"><a-p>  mount at `/data`. Also, mount a [`tmpfs`](https://docs.docker.com/reference/compose-file/services/#tmpfs) at `/app/frontend/final`.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L332" href="#L332">332</a><span class="code-text"><a-p>- [Deny privileges to processes](https://docs.docker.com/reference/compose-file/services/#security_opt)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L333" href="#L333">333</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L334" href="#L334">334</a><span class="code-text"><a-p>## </a-p><a-tt>Deploying in your Kubernetes cluster with Helm</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L335" href="#L335">335</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L336" href="#L336">336</a><span class="code-text"><a-p>The helm values are very sparse to keep it simple. If you need more values to be variable, feel free to adjust.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L337" href="#L337">337</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L338" href="#L338">338</a><span class="code-text"><a-p>The PVC allocates 100Mi and the PV is using a host path volume.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L339" href="#L339">339</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L340" href="#L340">340</a><span class="code-text"><a-p>The helm chart assumes you have [cert manager](https://github.com/jetstack/cert-manager) deployed to have TLS</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L341" href="#L341">341</a><span class="code-text"><a-p>certificates managed easily in your cluster. Feel free to remove the issuer and adjust the ingress if you&#39;re on</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L342" href="#L342">342</a><span class="code-text"><a-p>AWS with EKS for example. To install cert-manager, I recommend using the</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L343" href="#L343">343</a><span class="code-text"><a-p>[&quot;kubectl apply&quot; way](https://cert-manager.io/docs/installation/kubectl/) to install cert-manager.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L344" href="#L344">344</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L345" href="#L345">345</a><span class="code-text"><a-p>To get started, `cp deploy/helm-chart/values.yaml deploy/helm-chart/my-values.yaml` and adjust `password`, `fqdn`</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L346" href="#L346">346</a><span class="code-text"><a-p>and `letsencryptmail` in your new `my-values.yaml`, then just run.</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L347" href="#L347">347</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L348" href="#L348">348</a><span class="code-text"><a-p>[All the related files can be found here.](../deploy/helm-chart)</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L349" href="#L349">349</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L350" href="#L350">350</a><span class="code-text"><a-p>```</a-p><a-tl>bash</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L351" href="#L351">351</a><span class="code-text"><a-p>cd helm-chart</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L352" href="#L352">352</a><span class="code-text"><a-p>helm upgrade </a-p><a-co>--install</a-co><a-p> chhoto-url . </a-p><a-co>-n</a-co><a-p> chhoto-url </a-p><a-co>--create-namespace</a-co><a-p> </a-p><a-co>-f</a-co><a-p> my-values.yaml</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L353" href="#L353">353</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
