fork/chhoto-url

git clone https://git.julia.blue/fork/chhoto-url

SinTan1729docs: Updated with some new info03cef91

unicode
20.3 KiB593 linesraw
1<!-- SPDX-FileCopyrightText: 2023-2026 Sayantan Santra <sayantan.santra689@gmail.com> -->
2<!-- SPDX-License-Identifier: MIT -->
3
4<!doctype html>
5<html lang="en">
6  <head>
7    <meta charset="UTF-8" />
8    <title>Chhoto URL - Blazingly Fast, Selfhosted URL Shortener</title>
9    <meta
10      name="viewport"
11      content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
12    />
13    <meta http-equiv="X-UA-Compatible" content="ie=edge" />
14    <meta
15      name="description"
16      content="A simple, blazingly fast, selfhosted URL shortener with no unnecessary features; written in Rust."
17    />
18    <meta
19      itemprop="image"
20      content="https://chhoto.link/static/assets/banner.png"
21    />
22
23    <meta property="og:title" content="Chhoto URL" />
24    <meta
25      property="og:description"
26      content="A simple, blazingly fast, selfhosted URL shortener with no unnecessary features; written in Rust."
27    />
28    <meta
29      property="og:image"
30      content="https://chhoto.link/static/assets/banner.png"
31    />
32    <meta property="og:url" content="https://chhoto.link" />
33    <meta
34      name="keywords"
35      content="url shortener, link shortener, self hosted, open source"
36    />
37
38    <link
39      rel="icon"
40      type="image/x-icon"
41      href="static/assets/favicon.ico"
42      sizes="any"
43    />
44    <link rel="icon" type="image/svg+xml" href="static/assets/favicon.svg" />
45    <link
46      rel="icon"
47      type="image/png"
48      href="static/assets/favicon-32.png"
49      sizes="32x32"
50    />
51    <link
52      rel="icon"
53      type="image/png"
54      href="static/assets/favicon-196.png"
55      sizes="196x196"
56    />
57    <link rel="preconnect" href="https://fonts.googleapis.com" />
58    <link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
59    <link
60      href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&display=swap"
61      rel="stylesheet"
62    />
63    <link
64      href="https://fonts.googleapis.com/css2?family=JetBrains+Mono&display=swap"
65      rel="stylesheet"
66    />
67    <link
68      href="https://fonts.googleapis.com/css2?family=Noto+Sans+Bengali:wght@400;700&display=swap"
69      rel="stylesheet"
70    />
71    <script src="static/script.js" defer></script>
72    <link rel="stylesheet" href="static/styles.css" />
73    <link rel="canonical" href="https://chhoto.link" />
74  </head>
75  <body>
76    <header class="site-header">
77      <div class="container nav">
78        <div class="brand-group">
79          <div class="brand-wrap">
80            <img src="static/assets/favicon.svg" alt="chhoto-url-logo" />
81            <a class="brand" href="#top">Chhoto URL</a>
82          </div>
83        </div>
84
85        <button
86          class="nav-toggle"
87          id="navToggle"
88          type="button"
89          aria-expanded="false"
90          aria-controls="siteNav"
91          aria-label="Toggle navigation"
92        >
93          Menu
94        </button>
95
96        <nav class="nav-links" id="siteNav" aria-label="Primary navigation">
97          <a href="#features">Features</a>
98          <a href="#screenshots">Screenshots</a>
99          <a href="#quickstart">Quick Start</a>
100          <a href="#about">About Me</a>
101          <a href="#links">Links</a>
102        </nav>
103      </div>
104    </header>
105
106    <main id="top">
107      <section class="hero">
108        <div class="container hero-inner">
109          <div class="brand-stats" aria-label="Project stats">
110            <a
111              class="brand-stat"
112              href="https://github.com/SinTan1729/chhoto-url"
113              target="_blank"
114              rel="noopener noreferrer"
115            >
116              <img
117                class="badge badge-light"
118                src="https://img.shields.io/github/stars/SinTan1729/chhoto-url?style=flat&label=stars&color=f3f4f6&labelColor=e5e7eb&logo=github&logoColor=111827"
119                alt="GitHub stars"
120              />
121              <img
122                class="badge badge-dark"
123                src="https://img.shields.io/github/stars/SinTan1729/chhoto-url?style=flat&label=stars&color=1f2937&labelColor=111827&logo=github&logoColor=f9fafb"
124                alt="GitHub stars"
125              />
126            </a>
127            <a
128              class="brand-stat"
129              href="https://codeberg.org/SinTan1729/chhoto-url"
130              target="_blank"
131              rel="noopener noreferrer"
132            >
133              <img
134                class="badge badge-light"
135                src="https://img.shields.io/gitea/stars/SinTan1729/chhoto-url?gitea_url=https%3A%2F%2Fcodeberg.org&style=flat&logo=codeberg&color=f3f4f6&labelColor=e5e7eb&logoColor=2496ed"
136                alt="Codeberg Stars"
137              />
138              <img
139                class="badge badge-dark"
140                src="https://img.shields.io/gitea/stars/SinTan1729/chhoto-url?gitea_url=https%3A%2F%2Fcodeberg.org&style=flat&logo=codeberg&color=1f2937&labelColor=111827&logoColor=7dd3fc"
141                alt="Codeberg stars"
142              />
143            </a>
144            <a
145              class="brand-stat"
146              href="https://hub.docker.com/r/sintan1729/chhoto-url"
147              target="_blank"
148              rel="noopener noreferrer"
149            >
150              <img
151                class="badge badge-light"
152                src="https://img.shields.io/docker/pulls/sintan1729/chhoto-url?style=flat&label=pulls&color=f3f4f6&labelColor=e5e7eb&logo=docker&logoColor=2496ed"
153                alt="Docker pulls"
154              />
155              <img
156                class="badge badge-dark"
157                src="https://img.shields.io/docker/pulls/sintan1729/chhoto-url?style=flat&label=pulls&color=1f2937&labelColor=111827&logo=docker&logoColor=7dd3fc"
158                alt="Docker pulls"
159              />
160            </a>
161            <a
162              class="brand-stat"
163              href="https://github.com/SinTan1729/chhoto-url/pkgs/container/chhoto-url"
164              target="_blank"
165              rel="noopener noreferrer"
166            >
167              <img
168                class="badge badge-light"
169                src="https://img.shields.io/badge/dynamic/json?url=https://ghcr-badge.elias.eu.org/api/SinTan1729/chhoto-url&query=downloadCount&label=pulls&style=flat&logo=github&color=f3f4f6&labelColor=e5e7eb&logoColor=2496ed"
170                alt="GHCR pulls"
171              />
172              <img
173                class="badge badge-dark"
174                src="https://img.shields.io/badge/dynamic/json?url=https://ghcr-badge.elias.eu.org/api/SinTan1729/chhoto-url&query=downloadCount&label=pulls&style=flat&logo=github&color=1f2937&labelColor=111827&logoColor=7dd3fc"
175                alt="GHCR pulls"
176              />
177            </a>
178          </div>
179          <p class="eyebrow">Blazingly fast self-hosted URL shortener</p>
180          <h1>Short links, self-hosted.</h1>
181          <p class="hero-text">
182            Chhoto (<span class="bn">ছোট</span>,
183            <a
184              href="https://en.wiktionary.org/wiki/%E0%A6%9B%E0%A7%8B%E0%A6%9F"
185              target="_blank"
186              >pronunciation</a
187            >) URL is a lightweight URL shortener written in Rust. It is built
188            for simple self-hosted deployment and provides the core tools needed
189            to create and manage short links on your own infrastructure.
190          </p>
191          <p class="hero-text">
192            It's written in <code>async Rust</code>, using
193            <a href="https://actix.rs/" target="_blank">Actix Web</a> as the
194            backend. The frontend is written in <code>html</code>,
195            <code>css</code>, and vanilla <code>javascript</code>. Links are
196            stored in an
197            <a href="https://sqlite.org" target="_blank">SQLite database</a>.
198            It's distributed in a tiny container image (&lt;4.5 MB for the
199            <code>scratch</code> image and &lt;8.5 MB for the
200            <code>alpine</code> image, both compressed), and uses &lt;10 MB of
201            RAM under regular load.
202          </p>
203          <p>
204            It’s free and open source, released under the
205            <a href="https://spdx.org/licenses/MIT.html">MIT license</a>,
206            maintained by
207            <a href="https://github.com/SinTan1729"><code>SinTan1729</code></a
208            >.
209          </p>
210          <p>
211            <strong>No tracking. No bullshit. Blazingly fast.</strong>
212          </p>
213
214          <div class="hero-actions">
215            <a
216              class="btn btn-primary"
217              href="https://github.com/SinTan1729/chhoto-url"
218              target="_blank"
219              rel="noopener noreferrer"
220            >
221              View on GitHub
222            </a>
223            <a
224              class="btn btn-secondary"
225              href="https://codeberg.org/SinTan1729/chhoto-url"
226              target="_blank"
227              rel="noopener noreferrer"
228            >
229              Codeberg Mirror
230            </a>
231            <a
232              class="btn btn-secondary"
233              href="https://github.com/SinTan1729/chhoto-url/blob/main/docs/INSTALLATION.md"
234              target="_blank"
235              rel="noopener noreferrer"
236            >
237              Installation Guide
238            </a>
239          </div>
240
241          <div class="latest-version">
242            <div class="latest-version">
243              <span class="version-label">Latest version:</span>
244              <a
245                href="https://github.com/SinTan1729/chhoto-url/releases/latest"
246                target="_blank"
247                rel="noopener noreferrer"
248              >
249                <img
250                  class="badge badge-light"
251                  src="https://img.shields.io/github/v/release/SinTan1729/chhoto-url?display_name=tag&sort=semver&style=flat&color=f3f4f6&labelColor=e5e7eb&logo=github&logoColor=111827"
252                  alt="Latest release version"
253                />
254                <img
255                  class="badge badge-dark"
256                  src="https://img.shields.io/github/v/release/SinTan1729/chhoto-url?display_name=tag&sort=semver&style=flat&color=1f2937&labelColor=111827&logo=github&logoColor=f9fafb"
257                  alt="Latest release version"
258                />
259              </a>
260            </div>
261          </div>
262
263          <div class="hero-meta hero-actions" aria-label="Demo link">
264            <span class="hero-meta-label">Live Demo:</span>
265            <a
266              class="hero-meta-link"
267              href="https://demo.chhoto.link"
268              target="_blank"
269              rel="noopener noreferrer"
270            >
271              demo.chhoto.link
272            </a>
273            <span class="hero-meta-sep">•</span>
274            <span class="hero-meta-password">
275              Password: <code>chhoto-url-demo-pass</code>
276            </span>
277          </div>
278        </div>
279      </section>
280
281      <section class="section" id="features">
282        <div class="container narrow">
283          <div class="section-heading">
284            <p class="eyebrow">Features</p>
285            <h2>A quick overview</h2>
286          </div>
287
288          <div class="card-grid">
289            <article class="card">
290              <h3>Custom short links</h3>
291              <p>Create short URLs with generated slugs or custom aliases.</p>
292            </article>
293
294            <article class="card">
295              <h3>Link expiry</h3>
296              <p>
297                Set short links to expire automatically after a chosen duration.
298              </p>
299            </article>
300
301            <article class="card">
302              <h3>Hit counting</h3>
303              <p>Track how many times a short link has been used.</p>
304            </article>
305
306            <article class="card">
307              <h3>Edit links</h3>
308              <p>Update existing links and manage their metadata.</p>
309            </article>
310
311            <article class="card">
312              <h3>Notes and filtering</h3>
313              <p>Attach notes to links and filter them in the web UI.</p>
314            </article>
315
316            <article class="card">
317              <h3>QR codes and API support</h3>
318              <p>
319                Generate QR codes and integrate with the service
320                programmatically.
321              </p>
322            </article>
323
324            <article class="card">
325              <h3>Customization</h3>
326              <p>
327                Tailor the backend and frontend to your needs, or serve any
328                static website as the frontend. (This very website is served
329                that way.)
330              </p>
331            </article>
332
333            <article class="card">
334              <h3>Zero bloat</h3>
335              <p>
336                No ads, no paywalls, no interstitial pages, no begging for
337                donations, no analytics. That's not our style.
338              </p>
339            </article>
340          </div>
341        </div>
342      </section>
343
344      <section class="section" id="screenshots">
345        <div class="container narrow">
346          <div class="section-heading">
347            <p class="eyebrow">Screenshots</p>
348            <h2>Snappy WebUI</h2>
349          </div>
350          <div class="screenshots-pair">
351            <figure class="screenshot-frame">
352              <img
353                src="static/assets/screenshot-desktop.webp"
354                alt="Chhoto URL desktop interface"
355                loading="lazy"
356              />
357            </figure>
358
359            <figure class="screenshot-frame">
360              <img
361                src="static/assets/screenshot-mobile.webp"
362                alt="Chhoto URL mobile interface"
363                loading="lazy"
364              />
365            </figure>
366          </div>
367        </div>
368      </section>
369
370      <section class="section" id="quickstart">
371        <div class="container narrow">
372          <div class="section-heading">
373            <p class="eyebrow">Quick Start</p>
374            <h2>Getting started</h2>
375          </div>
376
377          <div class="stack">
378            <div class="panel">
379              <h3>1. Deploy the service</h3>
380              <p>
381                Run Chhoto URL with Docker, Podman, or another OCI-compatible
382                container workflow.
383              </p>
384            </div>
385
386            <div class="panel">
387              <h3>2. Configure the application</h3>
388              <p>
389                Set the required environment variables for the site URL,
390                credentials, and storage configuration.
391              </p>
392            </div>
393
394            <div class="panel">
395              <h3>3. Start creating short links</h3>
396              <p>
397                Use the web interface to create, edit, and manage short URLs on
398                your own instance.
399              </p>
400            </div>
401          </div>
402        </div>
403      </section>
404
405      <section class="section" id="about">
406        <div class="container narrow">
407          <div class="section-heading">
408            <p class="eyebrow">About me</p>
409            <h2>
410              Hi, I'm Sayantan Santra <span class="bn">(সায়ন্তন সাঁতরা)</span>
411            </h2>
412          </div>
413
414          <div class="panel">
415            <p>
416              I’m a Mathematics researcher and do some programming as a hobby. I
417              mostly code in <code>Rust</code>, <code>Go</code>,
418              <code>Python</code>, and <code>Bash</code>. For my research, I
419              work in Algebraic and Computational Number Theory. You can find
420              more information about me on
421              <a href="https://chhoto.link/me" target="_blank">my website</a>.
422            </p>
423          </div>
424        </div>
425      </section>
426
427      <section class="section" id="links">
428        <div class="container narrow">
429          <div class="section-heading">
430            <p class="eyebrow">Links</p>
431            <h2>Project resources</h2>
432          </div>
433
434          <div class="stack">
435            <div class="resource-links">
436              <a
437                class="resource-link"
438                href="https://github.com/SinTan1729/chhoto-url"
439                target="_blank"
440                rel="noopener noreferrer"
441              >
442                <strong>GitHub</strong>
443                <span>Source code, README, releases, and updates</span>
444              </a>
445
446              <a
447                class="resource-link"
448                href="https://codeberg.org/SinTan1729/chhoto-url"
449                target="_blank"
450                rel="noopener noreferrer"
451              >
452                <strong>Codeberg</strong>
453                <span>Mirror Codeberg repository</span>
454              </a>
455            </div>
456
457            <a
458              class="resource-link"
459              href="https://github.com/SinTan1729/chhoto-url/blob/main/docs/INSTALLATION.md"
460              target="_blank"
461              rel="noopener noreferrer"
462            >
463              <strong>Installation and configuration guide</strong>
464              <span
465                >Setup steps, environment variables, and deployment notes</span
466              >
467            </a>
468
469            <a
470              class="resource-link"
471              href="https://github.com/SinTan1729/chhoto-url/blob/main/docs/CLI.md"
472              target="_blank"
473              rel="noopener noreferrer"
474            >
475              <strong>CLI Usage</strong>
476              <span>Guide for CLI usage</span>
477            </a>
478
479            <div class="resource-links">
480              <a
481                class="resource-link"
482                href="https://hub.docker.com/r/sintan1729/chhoto-url"
483                target="_blank"
484                rel="noopener noreferrer"
485              >
486                <strong>Docker Hub</strong>
487                <span>Container image from Docker Hub</span>
488              </a>
489
490              <a
491                class="resource-link"
492                href="https://ghcr.io/sintan1729/chhoto-url"
493                target="_blank"
494                rel="noopener noreferrer"
495              >
496                <strong>GHCR</strong>
497                <span>Container image from GHCR</span>
498              </a>
499            </div>
500
501            <a
502              class="resource-link"
503              href="https://github.com/SinTan1729/chhoto-url/blob/main/docs/TOOLS.md"
504              target="_blank"
505              rel="noopener noreferrer"
506            >
507              <strong>Third party tools</strong>
508              <span>Tools to interact with Chhoto URL</span>
509            </a>
510
511            <div class="panel developer-links">
512              <h3>Developer</h3>
513              <p>Personal links for the maintainer of Chhoto URL.</p>
514
515              <div class="resource-links">
516                <a
517                  class="resource-link"
518                  href="https://chhoto.link/me"
519                  target="_blank"
520                  rel="noopener noreferrer"
521                >
522                  <strong>Website</strong>
523                  <span>Personal academic website</span>
524                </a>
525
526                <a
527                  class="resource-link"
528                  href="https://github.com/Sintan1729"
529                  target="_blank"
530                  rel="noopener noreferrer"
531                >
532                  <strong>GitHub Profile</strong>
533                  <span>Other repositories and development work</span>
534                </a>
535              </div>
536
537              <div class="resource-links">
538                <a
539                  class="resource-link"
540                  href="https://mas.to/@sayantansantra"
541                  target="_blank"
542                  rel="noopener noreferrer"
543                >
544                  <strong>Mastodon</strong>
545                  <span>Random posts</span>
546                </a>
547
548                <a
549                  class="resource-link"
550                  href="mailto:mail@sayantansantra.com"
551                  target="_blank"
552                  rel="noopener noreferrer"
553                >
554                  <strong>Contact</strong>
555                  <span>mail@sayantansantra.com</span>
556                </a>
557              </div>
558            </div>
559          </div>
560        </div>
561      </section>
562    </main>
563
564    <footer class="site-footer">
565      <p class="container">
566        Chhoto URL - Blazingly fast self-hosted URL shortener.
567      </p>
568      <div class="container footer-inner">
569        <a
570          href="https://chhoto.link/me"
571          target="_blank"
572          rel="noopener noreferrer"
573        >
574          About Me
575        </a>
576        <a
577          href="https://codeberg.org/SinTan1729/chhoto-url"
578          target="_blank"
579          rel="noopener noreferrer"
580        >
581          Codeberg
582        </a>
583        <a
584          href="https://github.com/SinTan1729/chhoto-url"
585          target="_blank"
586          rel="noopener noreferrer"
587        >
588          GitHub
589        </a>
590      </div>
591    </footer>
592  </body>
593</html>