{"id":15533271,"url":"https://github.com/keyweeusr/onser","last_synced_at":"2025-04-15T16:39:21.535Z","repository":{"id":153046472,"uuid":"147250658","full_name":"KeyWeeUsr/Onser","owner":"KeyWeeUsr","description":":whale2: Simple Docker image for Onion Hidden Service (.onion)","archived":false,"fork":false,"pushed_at":"2018-09-22T12:28:45.000Z","size":29,"stargazers_count":7,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T22:32:05.304Z","etag":null,"topics":["onion","onion-address","onion-domains","onion-service","tor","tor-hidden-services","tor-network"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/keyweeusr/onser","language":"Dockerfile","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/KeyWeeUsr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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":"2018-09-03T20:28:01.000Z","updated_at":"2023-05-16T06:33:28.000Z","dependencies_parsed_at":"2023-07-10T02:18:53.241Z","dependency_job_id":null,"html_url":"https://github.com/KeyWeeUsr/Onser","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/KeyWeeUsr%2FOnser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2FOnser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2FOnser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2FOnser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KeyWeeUsr","download_url":"https://codeload.github.com/KeyWeeUsr/Onser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249109866,"owners_count":21214237,"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":["onion","onion-address","onion-domains","onion-service","tor","tor-hidden-services","tor-network"],"created_at":"2024-10-02T11:35:13.000Z","updated_at":"2025-04-15T16:39:21.509Z","avatar_url":"https://github.com/KeyWeeUsr.png","language":"Dockerfile","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Onser\n\n... or \"Onion (Hidden) Service\". Onser is a simple Docker image allowing you to\nvery quickly create an Onion hidden service for the TOR network.\nBased on NGINX and latest Tor.\n\n\n### Run\n\n1. Get [Docker](https://www.docker.com/get-started)\n2. Get Tor Browser\n   [via torproject.org](https://www.torproject.org/download/download-easy.html.en),\n   [via email](mailto://gettor@torproject.org),\n   [via twitter](https://twitter.com/get_tor)\n3. ``git clone https://github.com/KeyWeeUsr/Onser``\n4. Put your files into the ``www`` folder\n5. Run the ``run.bat`` (Windows) or ``source run.sh`` (MacOS or GNU/Linux)\n6. Get your .onion address: ``docker exec -it $(docker ps -q) cat www/hostname``\n7. Navigate to the .onion address in the Tor Browser\n8. Enjoy\n\n\n### Multiple services\n\nYou can use ``docker-compose.yml`` to run multiple separate onion services with\nmultiple ``www`` folders set via build argument ``www_folder`` (similarly\n``nginx_conf``). See the default compose file.\n\nTo build and run the services you need just a single command:\n\n    docker-compose up -d\n\nwhich will build the images and run the containers.\n\nTo get the .onion URLs use:\n\n    docker-compose exec one cat www/hostname\n    docker-compose exec two cat www/hostname\n    docker-compose exec three cat www/hostname\n\nEach service has a separate volume specified in the compose file thus holds\na unique ``private_key`` for the service.\n\nTo remove containers, volumes, images, networks use:\n\n    docker-compose down --volumes --rmi all\n\n\n### Default permissions\n\nBy default the permissions will be changed during the Docker image build\nthis way:\n\n* `www` folder permissions to `0700`\n    (user: rwx, group: ---, others: ---)\n\n* the contents of the `www` folder to `0644`\n    (user: rw-, group: r--, others: r--).\n\n\n### Custom permissions\n\nTo modify the permissions to your liking you can use this example:\n\n    FROM keyweeusr/onser:\u003ctag\u003e\n    USER root\n\n    # folder\n    RUN chmod 0123 /home/onser/www\n\n    # folder + files\n    RUN chmod -R 0123 /home/onser/www\n    USER onser\n\n\n### Issues\n\nSometimes building the Docker image fails due to importing the ``gpg`` keys.\n\n    gpg: directory '/root/.gnupg' created\n    gpg: keybox '/root/.gnupg/pubring.kbx' created\n    gpg: keyserver receive failed: Cannot assign requested address\n\n\n### Disclaimer\n\nMade for educational purposes, in my free time, unrelated to any\ninstitution/company/subject/... I was or am in contact with.\n\n\n### PS\n\nPlease do not use it for nasty crap\nand/or don't connect me with it if you do anyway.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeyweeusr%2Fonser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeyweeusr%2Fonser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeyweeusr%2Fonser/lists"}