{"id":15672400,"url":"https://github.com/noot/onion-server","last_synced_at":"2025-05-06T21:22:19.615Z","repository":{"id":122592306,"uuid":"481261249","full_name":"noot/onion-server","owner":"noot","description":"serve a static website as a .onion hidden service","archived":false,"fork":false,"pushed_at":"2022-04-15T02:35:59.000Z","size":16,"stargazers_count":17,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T03:03:25.108Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","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/noot.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}},"created_at":"2022-04-13T14:58:48.000Z","updated_at":"2024-10-15T09:58:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"5b9b4c53-efec-4512-a73c-c6fa6acf2724","html_url":"https://github.com/noot/onion-server","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noot%2Fonion-server","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noot%2Fonion-server/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noot%2Fonion-server/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/noot%2Fonion-server/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/noot","download_url":"https://codeload.github.com/noot/onion-server/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252770010,"owners_count":21801463,"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":[],"created_at":"2024-10-03T15:25:27.803Z","updated_at":"2025-05-06T21:22:19.594Z","avatar_url":"https://github.com/noot.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hidden service server\n\nA CLI that will host a static website as a .onion hidden service.\n\nComes with an additional binary that can be used to generate vanity .onion addresses.\n\n## Requirements\n\n- go1.17\n- tor 0.4.x\n\t- download source here https://www.torproject.org/download/tor/ or `wget https://dist.torproject.org/tor-0.4.6.10.tar.gz`\n\t- download additional dependencies: `sudo apt install libevent-dev libssl-dev zlib1g zlib1g-dev -y`\n\t- extract files (`tar -xzf`) and navigate to directory \n\t- `./configure \u0026\u0026 make \u0026\u0026 sudo make install`. Check that tor is installed with `tor --version`.\n\n## Usage\n\n### Build\n\n```\nmake build\n```\n\nThis places the binaries `onioncli` and `onionaddress` in the project root.\n\n### Run\n\nInstead of building the project, you can also run it:\n```\ngo run ./cmd/... [flags]\n```\n\n### Usage\n\nTo serve a static website:\n```bash\n./onioncli --serve-dir ~/my-website\n$ 2022-04-13T10:44:44.217-0400\tINFO\tcmd\tcmd/main.go:153\tOpen Tor browser and navigate to http://7ukuzklqxkwesfs3dla5zzj3bsjb6v2rx25bq3fr662qistclpixgxqd.onion\n```\n\nIf you have run the CLI before and have a server private key already (by default stored in `service.key`), you can pass it to the CLI so that the .onion address used will be the same as before.\n\n```bash\n./onioncli --private-key=service.key --serve-dir ~/my-website\n```\n\nYou can also turn on debug logs with `--log=debug`.\n\n#### Vanity addresses\n\nTo find a vanity address and its private key:\n```bash\n./onionaddress --prefix \u003csome-prefix\u003e --count=3\n```\n\nThis will search for and print 3 .onion addresses with the given prefix and their corresponding private keys. The private keys can be used with `onioncli --private-key=\u003ckeyfile\u003e`.\n\nNote: for 4-letter prefixes and less, this process is quite quick. For 5-letter prefixes, it took around ~30 minutes on my machine to find 1 address, for a 6-letter prefix, it took ~90 minutes. This grows exponentially the longer the prefix gets.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoot%2Fonion-server","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnoot%2Fonion-server","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnoot%2Fonion-server/lists"}