{"id":21055492,"url":"https://github.com/jamestthompson3/tendril-wiki","last_synced_at":"2025-05-15T23:32:42.351Z","repository":{"id":42200543,"uuid":"356028051","full_name":"jamestthompson3/tendril-wiki","owner":"jamestthompson3","description":"Personal knowledge management tool","archived":false,"fork":false,"pushed_at":"2024-06-11T18:49:02.000Z","size":4513,"stargazers_count":28,"open_issues_count":1,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-03T17:01:33.006Z","etag":null,"topics":["knowledge-base","notetaking","rust","tools-for-thought"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jamestthompson3.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-04-08T19:36:05.000Z","updated_at":"2025-03-25T21:59:23.000Z","dependencies_parsed_at":"2024-03-25T22:29:38.394Z","dependency_job_id":"54b0124d-69db-4202-8910-cd3ebc2ea1bd","html_url":"https://github.com/jamestthompson3/tendril-wiki","commit_stats":null,"previous_names":[],"tags_count":46,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestthompson3%2Ftendril-wiki","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestthompson3%2Ftendril-wiki/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestthompson3%2Ftendril-wiki/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jamestthompson3%2Ftendril-wiki/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jamestthompson3","download_url":"https://codeload.github.com/jamestthompson3/tendril-wiki/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254442404,"owners_count":22071864,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["knowledge-base","notetaking","rust","tools-for-thought"],"created_at":"2024-11-19T16:45:46.628Z","updated_at":"2025-05-15T23:32:37.316Z","avatar_url":"https://github.com/jamestthompson3.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tendril Wiki\n\n[![Build And Test](https://github.com/jamestthompson3/platform/actions/workflows/rust.yml/badge.svg)](https://github.com/jamestthompson3/platform/actions/workflows/rust.yml)\n\n## Contents\n\n- [Installation](#Installation)\n- [Migration](#migration)\n- [Getting started](#getting-started)\n\n![Landing Page](assets/home_page.png)\n\n### Nice features\n\n- Self hosted, files can be composed easily with other tools since they are plaintext\n- Both light and dark themes\n- Can build your notebook as a static site\n\n![Tag Page](assets/screenshot1.png)\n![Note](assets/screenshot2.png)\n\n## Installation\n\n### From source\n\nThis requires you to have the Rust toolchain installed. You can install this by cloning the repo, and running `cargo install --path .` from inside the `bin` directory. Then run `tendril -i` to bring up the interactive bootstrapper.\n\n### From latest release\n\nDownload the latest binary for your OS from the releases page. After unzipping the folder, run `./tendril -i` to bootstrap your wiki. You will then want to add this to your path with `sudo mv ./tendril /usr/local/bin` or annotating you `.bashrc` to point to the location where you've unzipped the release folder.\n\n## Migration\n\nIf you have an existing Tendril Wiki installation that is pre v1.0.0, you will need to do the following steps to migrate it to the latest version:\n\n- Stop your currently running Tendril Wiki server.\n  - Note: You might want to temporarily disable git sync if you have it enabled. This will allow you to check the migration without pushing the changes to your git repository.\n  - v1 of Tendril Wiki uses wikitext instead of markdown and its initial release doesn't support the full markdown spec, so there might be broken formatting. If you still want full markdown support, do not migrate.\n- Add one addtional field to the `general` section of your config file. This field should be `check_for_updates` and its value is either `true` or `false`. This value determines whether or not the client will show a message when there is a new release of Tendril Wiki.\n- Run the migrate command. This will create a backup of your current wiki directory in the same parent directory as your wiki. This means if your wiki is located in `~/Documents/wiki`, the migration tool will create `~/Documents/tendril-backup`. The command for running the migration tool is `tendril -m`.\n- Restart your Tendril Wiki server and check the changes.\n- If the changes are acceptable, you can re-enable git sync if you turned it off, and restart your server to allow this change to take effect.\n\n## Getting started\n\nBefore starting, you'll need to run `tendril -i` to bootstrap your wiki. An important note here is that when asked for a password, you are not encrypting the notebook, but rather it acts as a password for the webserver. Unauthorized requests will be rejected, but the notebook itself will still be stored in plaintext files on disk.\n\n### Running the wiki\n\nAfter bootstrapping the wiki, you can run `tendril` to start the webserver.\n\nYou can also run tendril wiki as a service on your operating system. Inside the `services`\ndirectory, you'll find template files for both Linux and MacOS (PRs for Windows support are welcome\n:^) ). This will allow to configure tendril wiki to automatically start when you log into your\ncomputer.\n\n### Building a static site\n\nYou can also build a static site by runing `tendril -b`.\n\n### Updating your installation\n\nYou can make sure that you copy over any new template or config files after each update by running `tendril -u` after downloading the latest release or building from source.\n\n### Interstitial Journaling\n\nYou can use Tendril Wiki for interstitial journaling both through the command line or through the web interface! From\nthe command line, you can call `tendril`, followed by the line you want to add to the daily log:\n\n```bash\ntendril \"I'm working on adding features I want for my workflow in Tendril Wiki\"\n```\n\nThis will append the line to the daily log entry, or create the entry if it does not exist. It's important to note that\nyou will need to properly escape quotes from you shell if you choose to update the daily log via the CLI. After\nprocessing the entry, Tendril Wiki will also automatically update the git repo if you've chosen to use the git sync\nfeature in your config file.\n\n### Bookmark Archiving\n\nIf you tag a note with `bookmark`, and add `url:\u003cyour-url-here\u003e`, to the metadata editor, tendril\nwill automatically archive the full text of the URL. This text will subsequently be available to be\nsearched by tendril's search engine, allowing you to run a full text search on your bookmarks.\n\n### Customization\n\nYou can find your configuration and your custom CSS files in the config directory. The location of this directory depends on your platform and will be printed out when you run `tendril --version`.\n\nYou can also set a per-note favicon by uploading the image you wish to use as a favicon and then adding the \"icon\" field to the notes metadata:\n\n```md\n---\ntitle: magic and computers\nicon: potion.svg\ntags: [emergence, technology]\n---\n```\n\nThis will look for the `potion.svg` file uploaded by you and set it as the favicon for the `magic and computers` note.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamestthompson3%2Ftendril-wiki","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjamestthompson3%2Ftendril-wiki","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjamestthompson3%2Ftendril-wiki/lists"}