cd source
npm install

Public API

The public surface exposed from source/public/ts/main.ts is behavioral/DOM-level rather than a module export API. The following symbols are directly used and observable:

jdenticon.update

import jdenticon from 'jdenticon/standalone';
jdenticon.update(selector: string): void;

Scans the DOM for elements matching selector and renders an identicon SVG based on each element's data-jdenticon-value attribute. Call after DOM mutations that introduce new user avatars.

PDFObject.embed

import PDFObject from 'pdfobject';
PDFObject.embed(url: string, targetElement: Element | null): boolean;

Embeds a PDF from url into targetElement using an <embed> tag. Used for .pdf class elements whose data-src holds the PDF URL. Returns false if the browser does not support inline PDFs.

colorhash (internal DOM function)

// Internal function in main.ts — not exported, but reproducible:
function colorhash(): void;

Reads location.hash, finds the matching line element in .table-code, and toggles the selected CSS class on its next sibling. Invoke after hash-change events to highlight specific lines in code views.

Working examples

Scenario - Rendering identicons for user avatars

In a page where user handles are listed, add data-jdenticon-value to container elements and call update after the DOM is ready.

import jdenticon from 'jdenticon/standalone';

document.addEventListener('DOMContentLoaded', () => {
  // Dynamically injected user rows include data-jdenticon-value="username"
  const rows = document.querySelectorAll('[data-jdenticon-value]');
  console.log(`Rendering ${rows.length} identicons`);
  jdenticon.update('[data-jdenticon-value]');
});

Scenario - Embedding a PDF attachment inline

Given a <div class="pdf" data-src="/files/report.pdf"></div> rendered by the Go template, embed the PDF immediately at load time.

import PDFObject from 'pdfobject';

document.querySelectorAll<HTMLElement>('.pdf').forEach((el) => {
  const src = el.dataset.src ?? '';
  if (src) {
    const success = PDFObject.embed(src, el);
    if (!success) {
      el.textContent = 'PDF preview not supported in this browser.';
    }
  }
});

Scenario - Syncing datetime-local inputs to Unix timestamps on form submit

Opengist expiration forms use datetime-local inputs but the backend expects a Unix epoch via a hidden field. Replicate the pattern for any form that needs timezone-safe timestamp submission.

document.querySelectorAll<HTMLFormElement>('form.expirable').forEach((form) => {
  form.onsubmit = () => {
    form.querySelectorAll<HTMLInputElement>('input[type=datetime-local]').forEach((input) => {
      const hidden = document.createElement('input');
      hidden.type = 'hidden';
      hidden.name = 'expiredAtUnix';
      hidden.value = Math.floor(new Date(input.value).getTime() / 1000).toString();
      form.appendChild(hidden);
    });
    return true;
  };
});

File walkthrough

• .github/ - GitHub Actions pipelines: Go unit tests, Docker image release, Helm chart publish, and docs deploy.
• docker/ - Shell entrypoint that handles UID/GID remapping before starting the Opengist binary inside a container.
• docs/ - Full VitePress documentation site; rendered and hosted at opengist.io.
• helm/ - Production-ready Helm chart with deployment, ingress, HPA templates and a values file.
• internal/ - All Go backend code: HTTP router, SSH server, Git operations, database models, OAuth handlers, admin panel.
• public/ - Static assets bundled by webpack/esbuild: TypeScript source (ts/), Tailwind CSS (css/), images (img/).
• scripts/ - Auxiliary shell/Go scripts for development tasks (asset generation, DB migrations, etc.).
• templates/ - Go html/template files defining every server-rendered page and partial.
• CHANGELOG.md - Chronological release notes.
• LICENSE - AGPL-3.0 full license text.
• README.md - Quickstart, feature list, and links to documentation.
• config.yml - Reference configuration with all supported keys and their defaults.
• opengist.go - Go main package; parses config, wires dependencies, starts HTTP and SSH listeners.
• package.json - Frontend build toolchain and asset pipeline dependencies.

Common pitfalls and fixes

• Git version below 2.28 causes init.defaultBranch to be unrecognized and repository creation to fail silently — upgrade Git to 2.28+.
• opengist-home directory permissions must be writable by the process user; Docker deployments fail if the volume is owned by root and UID/GID env vars are not set.
• SQLite WAL mode conflicts occur when two Opengist processes share the same db-filename — ensure only one instance runs per data directory, or switch to PostgreSQL/MySQL.
• jdenticon ESM/CJS interop — import from jdenticon/standalone (as done in main.ts) not from the default export to avoid bundler issues with tree-shaking the full package.
• PDFObject fallback — Chromium-based browsers block inline PDFs on file:// origins; always serve assets over HTTP even in local development.
• Tailwind purge misconfiguration — if custom templates in templates/ use Tailwind classes that are absent from public/ts/, add templates/**/*.html to the content array in tailwind.config.js to prevent classes being stripped in production builds.

Vibe-coding prompt template

I have dropped the Opengist source into `./source/` in my project.
USAGE.md is also present at `./USAGE.md`.

The upstream package is `opengist` (Go backend, TypeScript/Tailwind frontend,
self-hosted Git-powered pastebin).

Please help me integrate it step-by-step:

1. Read USAGE.md and source/public/ts/main.ts to understand the frontend entry point.
2. Add the required npm dependencies (jdenticon, pdfobject, tailwindcss) to my package.json.
3. Configure webpack or my existing bundler to process source/public/ts/main.ts and
   source/public/css/tailwind.css, outputting to my existing public/ dist directory.
4. Wire the Go binary build into my Makefile or docker-compose so that
   `source/opengist.go` is compiled and started alongside my other services.
5. Show me how to pass configuration via environment variables (OG_HTTP_PORT,
   OG_SECRET_KEY, OG_DB_FILENAME) in my existing .env file.
6. If I need to embed identicons or PDF previews in my own pages, show me
   how to reuse the jdenticon.update and PDFObject.embed calls from main.ts.

Do not invent new APIs. Only use symbols and patterns visible in source/ and USAGE.md.

License and credit

Opengist is licensed under the AGPL-3.0 license — see source/LICENSE. Any modifications to the source must be released under the same license when the software is used over a network.

Upstream project: https://github.com/thomiceli/opengist Documentation: https://opengist.io/docs

This product’s unique contribution is clean room implementation of valuable code block into AVCP compatible standard.

The full install guide and integration prompts unlock after purchase.

OpenAPI Powered Interactive API Documentation Components

Automation, Utilities & Developer Tools

Free