{"id":13550853,"url":"https://github.com/tildeinstitute/tildewiki","last_synced_at":"2026-01-16T20:44:52.344Z","repository":{"id":64302098,"uuid":"182365331","full_name":"tildeinstitute/tildewiki","owner":"tildeinstitute","description":"Memory-caching static blog/wiki server","archived":false,"fork":false,"pushed_at":"2020-05-12T20:23:17.000Z","size":18616,"stargazers_count":18,"open_issues_count":1,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-11-22T18:02:41.960Z","etag":null,"topics":["blog","go","golang","tilde","tildes","tildeverse","wiki"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tildeinstitute.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-04-20T05:41:15.000Z","updated_at":"2025-09-23T13:23:25.000Z","dependencies_parsed_at":"2023-01-15T09:30:41.149Z","dependency_job_id":null,"html_url":"https://github.com/tildeinstitute/tildewiki","commit_stats":null,"previous_names":["gbmor/tildewiki"],"tags_count":12,"template":false,"template_full_name":null,"purl":"pkg:github/tildeinstitute/tildewiki","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tildeinstitute%2Ftildewiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tildeinstitute%2Ftildewiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tildeinstitute%2Ftildewiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tildeinstitute%2Ftildewiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tildeinstitute","download_url":"https://codeload.github.com/tildeinstitute/tildewiki/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tildeinstitute%2Ftildewiki/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28482295,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-16T11:59:17.896Z","status":"ssl_error","status_checked_at":"2026-01-16T11:55:55.838Z","response_time":107,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["blog","go","golang","tilde","tildes","tildeverse","wiki"],"created_at":"2024-08-01T12:01:38.524Z","updated_at":"2026-01-16T20:44:52.308Z","avatar_url":"https://github.com/tildeinstitute.png","language":"Go","funding_links":[],"categories":["Go","golang"],"sub_categories":[],"readme":"# TildeWiki [![Go Report Card](https://goreportcard.com/badge/github.com/gbmor/tildewiki)](https://goreportcard.com/report/github.com/gbmor/tildewiki) [![Travis CI](https://api.travis-ci.org/gbmor/tildewiki.svg?branch=master)](https://travis-ci.org/gbmor/tildewiki)\nTildeWiki is a memory-caching static site server. The possible uses of TildeWiki range from blogs to wikis, and more.\nLet me know if you adapt it to a new use-case, I'm always interested!\n\nOriginally designed around the needs of the [tildeverse](https://tildeverse.org).\u003csup\u003e\u003ca href=\"#1\"\u003e1\u003c/a\u003e\u003c/sup\u003e\n\n[\\[Features\\]](#features) | [\\[Installation\\]](#installation) | [\\[Benchmarks\\]](#benchmarks) | [\\[Notes\\]](#notes)\n\n## [v0.6.4](https://github.com/gbmor/tildewiki/releases/tag/v0.6.4)\nVersion 0.6.4 Changes:\n* Cleaned up code so it's nicer to read. Less extraneous whitespace, unnecessary comments, etc.\n* Refactored index and page cache a bit\n\n### Currently powering the [tilde.institute](https://tilde.institute) wiki: \n* [https://wiki.tilde.institute](https://wiki.tilde.institute) \n* [gtmetrix report](https://gtmetrix.com/reports/wiki.tilde.institute/F1tzxEch)\n\n## \u003ca name=\"features\"\u003e\u003c/a\u003eFeatures\n* Speed is a priority\n* Mobile-friendly pages\n* Markdown!\u003csup\u003e\u003ca href=\"#2\"\u003e2\u003c/a\u003e\u003c/sup\u003e\n* Compressed responses (gzip)\n* Uses [kognise/water.css](https://github.com/kognise/water.css) dark theme by\ndefault (and includes as an example, a simple but nice local CSS file)\u003csup\u003e\u003ca href=\"#3\"\u003e3\u003c/a\u003e\u003c/sup\u003e\n* `YAML` configuration\n* Automatically reloads config file when a change is detected.\n* Generates list of pages, then places at an anchor comment in the index page\n* Caches pages to memory and only re-renders when the file changes\n* Very configurable. For example:\n  * URL path for viewing pages\n  * Directory for page data\n  * File to use for index page\n  * Logging output (file, `stdout`, `null`) and file location\n* Runs as a multithreaded service, rather than via CGI\n* Easily use [Caddy](https://caddyserver.com) or Nginx to proxy requests to it. This allows you to use your\nexisting SSL certificates (or, in the case of Caddy, painlessly generate new ones).\n\n## \u003ca name=\"installation\"\u003e\u003c/a\u003eInstallation\n\nThe installation script uses `bash`, and the startup script uses `daemonize`. Both should\nbe available in any Linux distribution's package repositories. However, they are not\nrequired to use TildeWiki.\n\n### Using the scripts\n\nFirst, clone the repository or download and untar a release archive, then enter the directory.\n\n```\n$ git clone git://github.com/gbmor/tildewiki.git \u0026\u0026 cd tildewiki\n\n$ curl -L https://github.com/gbmor/tildewiki/archive/v0.6.3.tar.gz | tar xzvf - \u0026\u0026 cd tildewiki-v0.6.3\n```\n\nIf you used `git`, the master branch will be the most recent release. Development work stays\nin the `dev` branch, so there's no need to look for a tag.\n\nExecute `setup.sh` as root, with the `install` argument:\n\n```\n$ sudo ./setup.sh install\n```\n\nOnce you receive the confirmation message, and no errors have appeared, you may run the\nstartup script as root to test the installation:\n\n```\n$ sudo tildewiki\n```\n\nTildeWiki will drop privileges to the `tildewiki` user, which was created by the script.\n\nI'm going to add a `systemd` service file soon. For now, it'll need to be started like this.\n\n### Building manually\n\nIf you prefer, you can install it this way. Clone the repository or download a source archive\nlike above, and enter the directory. Once in the directory, you'll need to build the binary.\n\n```\n$ go build\n```\n\nIt won't take long. Also, it doesn't need to live in your `GOPATH` as\nit's been set up to use Go Modules.\n\nAfter it finishes, you can leave the binary where it is or move it somewhere else. Remember\nto move the `pages` and `assets` directories with it, along with `tildewiki.yaml`.\n\n### Setting up TildeWIki\n\nBegin by combing through `tildewiki.yaml` (if you used the scripts, it's in `/usr/local/tildewiki`)\nand changing the options to something appropriate to your site. Afterwards, place your markdown-formatted\npages into the directory specified by `PageDir` in the config and place your markdown-formatted \nindex file, containing the anchor comment `\u003c!--pagelist--\u003e`, into the `AssetsDir`. Feel free to\nchange the favicon and CSS to your liking.\n\nOnce that's all done, either run `/usr/local/bin/tildewiki` (if you've used the scripts) or run\nthe binary manually.\n\n### Serving TildeWiki\n\nUnless you plan on serving directly from :8080 (which is fine!), or whichever port you chose in \n`tildewiki.yaml`, I recommend proxying requests to TildeWiki so it can be served from a subdomain,\nfor example. There are several options for this, namely [Caddy](https://caddyserver.com/) and \n[nginx](https://nginx.org). The best option is for you to use Caddy: it integrates TLS certificate \nrenewal and has a *very* easy configuration syntax.\n\nIf you're going to use Nginx, here's an example server block for you to start with. Note: this \nexample uses TLS and http2. [LetsEncrypt](https://letsencrypt.org) is awesome, and free. \nTheir `certbot` tool is really easy to use.\n\n```\nserver {\n    server_name wiki.example.com;\n    listen [::]:443 ssl http2;\n    listen 0.0.0.0:443 ssl http2;\n    ssl_certificate /etc/letsencrypt/live/wiki.example.com/fullchain.pem;\n    ssl_certificate_key /etc/letsencrypt/live/wiki.example.com/privkey.pem;\n    include /etc/letsencrypt/options-ssl-nginx.conf;\n    ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;\n    location / {\n        proxy_set_header Host $host;\n        proxy_set_header X-Forwarded-For $remote_addr;\n        proxy_pass http://127.0.0.1:8080;\n    }\n}\nserver {\n    if ($host = wiki.example.com) {\n        return 301 https://$host$request_uri;\n    }\n    listen 80;\n    server_name wiki.example.com;\n    return 404;\n}\n```\n\n## \u003ca name=\"benchmarks\"\u003e\u003c/a\u003eBenchmarks\n\n* [bombardier](https://github.com/codesenberg/bombardier)\n\n```\n$ bombardier -c 100 -n 200000 http://localhost:8080\n\nBombarding http://localhost:8080 with 200000 request(s) using 100 connection(s)\n 200000 / 200000 [===========================================] 100.00% 7512/s 26s\nDone!\nStatistics        Avg      Stdev        Max\n  Reqs/sec      7548.57     663.04   10453.06\n  Latency       13.24ms     2.38ms    49.32ms\n  HTTP codes:\n    1xx - 0, 2xx - 200000, 3xx - 0, 4xx - 0, 5xx - 0\n    others - 0\n  Throughput:     8.55MB/s\n\n```\n\n* [baton](https://github.com/americanexpress/baton)\n```\n$ baton -u http://localhost:8080 -c 100 -r 200000\n\n...\n\n=========================== Results ========================================\n\nTotal requests:                                200000\nTime taken to complete requests:        27.270626274s\nRequests per second:                             7334\nMax response time (ms):                            52\nMin response time (ms):                             0\nAvg response time (ms):                         13.11\n\n========= Percentage of responses by status code ==========================\n\nNumber of connection errors:                        0\nNumber of 1xx responses:                            0\nNumber of 2xx responses:                       200000\nNumber of 3xx responses:                            0\nNumber of 4xx responses:                            0\nNumber of 5xx responses:                            0\n\n========= Percentage of responses received within a certain time (ms)======\n\n         9% : 5 ms\n        13% : 10 ms\n        79% : 15 ms\n        95% : 20 ms\n        98% : 25 ms\n        99% : 30 ms\n        99% : 35 ms\n        99% : 40 ms\n        99% : 45 ms\n       100% : 52 ms\n\n===========================================================================\n\n```\n\n## \u003ca name=\"notes\"\u003e\u003c/a\u003eNotes\n* Builds with `Go 1.11` and `Go 1.12`.\n* Tested on Linux (Ubuntu 18.04LTS, Debian 9, 10, and Sid) and OpenBSD 6.4\n\n1. \u003ca name=\"1\"\u003e\u003c/a\u003eFor [tildeverse](https://tildeverse.org) projects, we tend to use a PR\nworkflow for collaboration. For example, wiki pages are submitted to the repo via pull\nrequest. I'm currently evaluating other options for page creation and editing.\n\n2. \u003ca name=\"2\"\u003e\u003c/a\u003eUses a patched copy of [russross/blackfriday](https://github.com/russross/blackfriday)\n([gopkg](https://gopkg.in/russross/blackfriday.v2)) as the markdown\nparser. The patch allows injection of various `\u003cmeta.../\u003e` tags into\nthe document header during the `markdown-\u003ehtml` translation.\n\n   * The patched `v2` repository lives at:\n[gbmor-forks/blackfriday.v2-patched](https://github.com/gbmor-forks/blackfriday.v2-patched)\n   \n   * The patched `master` repo lives at:\n[gbmor-forks/blackfriday](https://github.com/gbmor-forks/blackfriday).\n   \n   * The PR can be found here: [allow writing of user-specified\n\u0026lt;meta.../\u0026gt;...](https://github.com/russross/blackfriday/pull/541)\n\n3. \u003ca name=\"3\"\u003e\u003c/a\u003eThe local CSS provided is the \"58 bytes of CSS\" from [https://jrl.ninja/etc/1/](https://jrl.ninja/etc/1/)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftildeinstitute%2Ftildewiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftildeinstitute%2Ftildewiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftildeinstitute%2Ftildewiki/lists"}