{"id":17069619,"url":"https://github.com/freethenation/tor-full","last_synced_at":"2025-10-26T09:10:48.983Z","repository":{"id":22824071,"uuid":"26171043","full_name":"freethenation/tor-full","owner":"freethenation","description":"A chef cookbook for tor","archived":false,"fork":false,"pushed_at":"2018-03-11T23:22:36.000Z","size":364,"stargazers_count":5,"open_issues_count":1,"forks_count":5,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-26T13:38:41.173Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/freethenation.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-04T13:59:14.000Z","updated_at":"2015-05-21T17:06:48.000Z","dependencies_parsed_at":"2022-08-17T16:55:34.035Z","dependency_job_id":null,"html_url":"https://github.com/freethenation/tor-full","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freethenation%2Ftor-full","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freethenation%2Ftor-full/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freethenation%2Ftor-full/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/freethenation%2Ftor-full/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/freethenation","download_url":"https://codeload.github.com/freethenation/tor-full/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248618859,"owners_count":21134312,"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-14T11:27:23.436Z","updated_at":"2025-10-26T09:10:43.926Z","avatar_url":"https://github.com/freethenation.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"Description\n===========\n\nInstalls Tor and optionally sets up a hidden service or configures as a relay\n\nRequirements\n============\n## Ohai and Chef:\n\n* Ohai: 6.14.0+\n\nThis cookbook makes use of `node['platform_family']` to simplify platform\nselection logic. This attribute was introduced in Ohai v0.6.12.\n\n## Platform:\n\nThe following platform families are supported:\n\n* Debian\n* RHEL\n* Fedora\n\n## Cookbooks:\n\n* apt (for Debian installation)\n* yum (for RHEL 5 installation)\n\n## Attributes\n\n### General config section\n* `node['tor']['DataDirectory']` - The directory for keeping all the keys/etc\n* `node['tor']['MinLogLevel']` - The minimum log level to log. Possible values include debug, info, notice, warn, and err.\n* `node['tor']['LogDestination']` - Where logs should be written. Valid values include a path to a file or \"syslog\"\n* `node['tor']['SocksPorts']` - List of 'address:port' to open tor socks proxy on. Defaults to disabled\n\n### Hidden Services config section\n\n* `node['tor']['HiddenServices']` - hidden services Tor should expose\n```ruby\n# Example\ndefault['tor']['hiddenServices'] = {\n  'HIDDEN_SERVICE_NAME':{\n  'HiddenServiceDir' =\u003e '/var/lib/tor/some_service/', #default is /var/lib/tor/HIDDEN_SERVICE_NAME/\n  'HiddenServicePorts' =\u003e ['80 127.0.0.1:80'] #x y:z says to redirect requests on port x to the address y:z\n}\n```\n\n### Relay config section\n\n* `node['tor']['relay']['enabled']` - if true tor will act as a relay\n* `node['tor']['relay']['ORPort']` - What port to advertise for incoming Tor connections\n* `node['tor']['relay']['Address']` - The IP address or full DNS name for incoming connections to your relay\n* `node['tor']['relay']['OutboundBindAddress']` - If you have multiple network interfaces, you can specify one for outgoing traffic to use\n* `node['tor']['relay']['Nickname']` - A handle for your relay, so people don't have to refer to it by key\n* `node['tor']['relay']['RelayBandwidthRate']` - Limit how much relayed traffic you will allow in kilobytes (not bits)\n* `node['tor']['relay']['RelayBandwidthBurst']` - Limit how much relayed traffic you will allow for bursts in kilobytes (not bits)\n* `node['tor']['relay']['ContactInfo']` - ContactInfo you can be reached at\n  * Example: `\"0xFFFFFFFF Random Person nobody AT example dot com\"`\n* `node['tor']['relay']['ExitPolicy']` - Sets the exit node policy for tor defaults to no exit\n  * Exampe: `['accept *:6660-6667','reject *:*'] # allow irc ports but no more`\n* `node['tor']['relay']['BridgeRelay']` - Set to 1 to run a bridge relay\n* `node['tor']['relay']['PublishServerDescriptor']` - Set to 0 to run a private bridge relay\n* `node['tor']['relay']['Directory']` - If true tor relay will server as a directory mirror\n* `node['tor']['relay']['DirPort']` - \"address:port\" from which to mirror directory information\n* `node['tor']['relay']['DirPortFrontPage']` - If true a blob of html will be returned on your DirPort explaining Tor.\n  * To send a custom HTML blob specify its full path, example `\"/etc/tor/tor-exit-notice.html\"`\n* `node['tor']['relay']['MyFamily']` - If you run more than one tor node add keyids for other tor nodes\n\nRecipes\n=======\n\n## tor-full::default\n\nInstalls Tor and enables Tor service. By default it will not open a socks proxy, offer a hidden service,\nor act as a relay.\n\n## tor-full::relay\n\nInstalls Tor and configs Tor to be a relay. By default the relay will not be an exit or directory.\nMake sure to read through the attributes section for relays above.\n\nUsage\n=====\n\nThis cookbook primarily installs Tor core packages. It can also be\nused to run a Tor relay or a hidden service.\n\nTo install tor client (all supported platforms):\n\n    include_recipe 'tor'\n\nTo install tor relay:\n\n    include_recipe \"tor::relay\"\n\nExamples\n-----\n### Open local socks port\nThe example role below opens a Tor socks proxy on port 9050 available to localhost only\n\n```ruby\nname \"torproxy\"\nrun_list(\"recipe[tor-full]\")\noverride_attributes(\n  \"tor\" =\u003e {\n    \"SocksPorts\" =\u003e [\"127.0.0.1:9050\"]\n  }\n)\n```\n\n### Hidden service on port 80\nThe example role below serves a website on port 80 as a hidden service. \n\n```ruby\nname \"torservice\"\nrun_list(\"recipe[tor-full]\")\noverride_attributes(\n  \"tor\" =\u003e {\n    \"hiddenServices\" =\u003e {\n      \"hidden_web_service\" =\u003e {\n       \"HiddenServicePorts\" =\u003e [\"80 127.0.0.1:8080\"]\n       #requests on port 80 are redirected to localhost port 8080\n      }\n    }\n  }\n)\n```\n\nNote: The `tor-full` recipe will write the hidden service's hostname to the attribute `node.tor.hiddenServices.HIDDEN_SERVICE_NAME.hostname` after node convergence.\n\n### Tor Relay\nThe node config below sets up a Tor relay. The relay is a directory and an exit\nfor IRC (ports 6660 \u0026 6667).\n\n```json\n{\n  \"run_list\": [\n    \"recipe[tor-full::relay]\"\n  ],\n  \"tor\": { \n    \"relay\": {\n      \"Address\":\"tor.icyego.com\",\n      \"Nickname\":\"IcyEgo\",\n      \"RelayBandwidthRate\":\"1000\",\n      \"RelayBandwidthBurst\":\"1100\",\n      \"ContactInfo\":\"ContactInfo 0x04FAC2E9CC21424A Richard Klafter \u003crpklafter@yahoo.com\u003e\",\n      \"Directory\":true,\n      \"ExitPolicy\":[\"accept *:6660-6667\",\"reject *:*\"]\n    }\n  }\n}\n\n```\n\nNote: you can make `recipe[tor-full]` behave like `recipe[tor-full::relay]` by \nsetting the attribute `tor.relay.enabled = true`.\n\nLicense and Author\n==================\n\n- Author:: Richard Klafter (\u003crpklafter@yahoo.com\u003e)\n- License:: MIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreethenation%2Ftor-full","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreethenation%2Ftor-full","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreethenation%2Ftor-full/lists"}