{"id":23747831,"url":"https://github.com/erwijet/aspen","last_synced_at":"2026-05-08T00:40:22.559Z","repository":{"id":141272169,"uuid":"609986290","full_name":"erwijet/aspen","owner":"erwijet","description":"A custom, keyword-based public search engine designed for a replacement for your bookmarks.","archived":false,"fork":false,"pushed_at":"2024-04-12T19:34:11.000Z","size":1767,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-06-24T23:41:36.414Z","etag":null,"topics":["grpc","productivity","rust","typescript"],"latest_commit_sha":null,"homepage":"https://aspn.app","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/erwijet.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"zenodo":null}},"created_at":"2023-03-05T20:17:25.000Z","updated_at":"2024-07-29T12:53:31.000Z","dependencies_parsed_at":"2025-05-24T19:07:40.872Z","dependency_job_id":"a704e6d3-6ad1-48bf-9e38-3f357bc0480f","html_url":"https://github.com/erwijet/aspen","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/erwijet/aspen","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erwijet%2Faspen","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erwijet%2Faspen/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erwijet%2Faspen/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erwijet%2Faspen/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/erwijet","download_url":"https://codeload.github.com/erwijet/aspen/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/erwijet%2Faspen/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32762283,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-07T02:14:30.463Z","status":"ssl_error","status_checked_at":"2026-05-07T02:14:29.405Z","response_time":62,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: 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":["grpc","productivity","rust","typescript"],"created_at":"2024-12-31T14:56:32.645Z","updated_at":"2026-05-08T00:40:22.544Z","avatar_url":"https://github.com/erwijet.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/erwijet/aspen/master/assets/aspen.png#gh-light-mode-only\" height=72 /\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/erwijet/aspen/master/assets/aspen-white.png#gh-dark-mode-only\" height=72 /\u003e\n\u003c/p\u003e\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://github.com/erwijet/aspen/actions/workflows/twig.yaml/badge.svg\" /\u003e\n  \u003cimg src=\"https://github.com/erwijet/aspen/actions/workflows/trunk.yaml/badge.svg\" /\u003e\n  \u003cimg src=\"https://vercelbadge.vercel.app/api/erwijet/aspen\" /\u003e\n\u003c/p\u003e\n\nAspen is a custom, keyword-based public search engine designed for a replacement for your bookmarks.\n\n---\n\n## Structure\n\n|Codebase|Description|\n|---|---|\n|[protos](/protos)|Protobuf specs|\n|[trunk](/trunk)|Rust gRPC server (authorization, db, keyword resolution)|\n|[twig](/twig)|Python HTTP interface|\n|[foliage](/foliage)|React web frontend|\n|[catkin](/catkin)|SwiftUI iOS frontend|\n---\n\n## How it Works\n\nAspen uses [site search](https://support.google.com/chrome/answer/95426?hl=en\u0026co=GENIE.Platform%3DDesktop#:~:text=Add%2C%20edit%2C%20or%20remove%20site%20search%20shortcuts) to allow you to quickly go to a page witout needing to point and click. Additionally, it doesn't rely on browser-specific customization, meaning your links will be preserved if you clear your browse cache/cookies, sign into a different account, use a different browser, or even a different computer.\n\n## Demo\n\n![demo](assets/aspen_demo.gif)\n\n## Self Hosting\n\nAspen is free and avalible at https://aspn.app, but can also be self hosted. Please refer to the following `docker-compose.yml`:\n\n```yml\nversion: '3.8'\nservices:\n  trunk:\n    image: \"ghcr.io/erwijet/aspen/trunk:latest\"\n    ports:\n      - 9000:9000\n    environment:\n      JWT_SECRET: \"\u003cyour_jwt_secret\u003e\"\n      MONGO_CONNECTION_STR: \"\u003cyour_conection_string\u003e\"\n  twig:\n    image: \"ghcr.io/erwijet/aspen/twig:latest\"\n    ports:\n      - 8000:8000\n```\n\n\u003e **please note** that if you choose to self host, you may need to update the URL targets in `twig`. They are hard-coded to point at `api.aspn.app`, but should be moved to an environment variable in a future release.\n\n### NGINX\n\nIt is recommended to set up some sort of proxy to handle TLS. Addtionally, gRPC requires http2. Please refer to the example nginx config.\n\n```nginx\n\n# trunk.example.com --\u003e your-host.example.com:9000\n\nserver {\n  set $forward_scheme http;\n  set $server         \"your-host.example.com\"; # \u003c- change this\n  set $port           9000;\n\n  listen 80;\n  listen [::]:80;\n\n  listen 443 ssl http2;\n  listen [::]:443 ssl http2;\n\n  server_name trunk.example.com; # \u003c-- change this\n\n  include conf.d/include/letsencrypt-acme-challenge.conf;\n  include conf.d/include/ssl-ciphers.conf;\n\n  ssl_certificate /path/to/fullchain.pem; # \u003c-- change this\n  ssl_certificate_key /path/to/privkey.pem; # \u003c-- and this\n\n  proxy_set_header Upgrade $http_upgrade;\n  proxy_set_header Connection $http_connection;\n  proxy_http_version 1.1;\n\n  location / {\n    proxy_set_header Upgrade $http_upgrade;\n    proxy_set_header Connection $http_connection;\n    proxy_http_version 1.1;\n\n    include conf.d/include/proxy.conf; # proxy\n  }\n}\n\n# api.example.com --\u003e your-host.example.com:8000\n\nserver {\n  set $forward_scheme http;\n  set $server         \"your-host.example.com\"; # \u003c-- change this\n  set $port           8000;\n\n  listen 80;\n  listen [::]:80;\n\n  listen 443 ssl http2;\n  listen [::]:443 ssl http2;\n\n  server_name api.example.com; # \u003c-- and this\n\n  include conf.d/include/letsencrypt-acme-challenge.conf;\n  include conf.d/include/ssl-ciphers.conf;\n\n  ssl_certificate /path/to/fullchain.pem; # \u003c-- also this\n  ssl_certificate_key /path/to/privkey.pem; # \u003c-- and this\n\n  location / {\n    include conf.d/include/proxy.conf; # proxy\n  }\n}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferwijet%2Faspen","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ferwijet%2Faspen","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ferwijet%2Faspen/lists"}