README.md

1.3 KB · raw

rendered · source

1# Kepr23Kepr is a self-hosted website for your [Koh](https://koh.asha.software) projects.4It reads your Koh remote and lets people browse the code and history you choose5to publish. You run it on your own domain, with your own storage, and keep6working in Koh from the terminal.78Visitors can read highlighted source, see file descriptions, and inspect diffs9at any save. They can download source archives or published releases, with10checksums and update feeds available for releases. Bug reports and questions11don't require a visitor account.1213Each instance has one operator. Repositories start private; you choose which14ones appear on the site. Kepr is built with TypeScript, Bun, Hono, and SQLite.1516[See Kepr in use](https://kepr.uk) · [Self-hosting guide](docs/site/docs.md)1718## Set up an instance1920You'll need Bun and a Koh 3 remote. You can use an S3-compatible bucket or try21Kepr locally with a folder remote. A public instance needs a domain and an HTTPS22reverse proxy.2324```sh25bun install --production26bun run start27```2829On the first run, open `/setup` on your instance (`http://localhost:3000/setup`30locally). The terminal prints a setup code. Enter it in the browser and set your31password, domain, and storage connection. Kepr saves the configuration and32starts syncing from your remote.3334Sign in to select the projects you want to make public.