{"id":13509912,"url":"https://github.com/snwfdhmp/octopus","last_synced_at":"2025-04-12T07:12:27.208Z","repository":{"id":98729379,"uuid":"97749736","full_name":"snwfdhmp/octopus","owner":"snwfdhmp","description":"Decentralized network mesh toolkit ✽","archived":false,"fork":false,"pushed_at":"2017-07-20T11:17:45.000Z","size":2073,"stargazers_count":23,"open_issues_count":0,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-12T07:12:19.975Z","etag":null,"topics":["communication","connection","decentralization","go","network","octopus","remote-access","remote-control","remote-shell","tool"],"latest_commit_sha":null,"homepage":"","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/snwfdhmp.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":"2017-07-19T18:39:50.000Z","updated_at":"2025-02-24T20:58:52.000Z","dependencies_parsed_at":"2023-05-25T01:00:14.245Z","dependency_job_id":null,"html_url":"https://github.com/snwfdhmp/octopus","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/snwfdhmp%2Foctopus","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snwfdhmp%2Foctopus/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snwfdhmp%2Foctopus/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/snwfdhmp%2Foctopus/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/snwfdhmp","download_url":"https://codeload.github.com/snwfdhmp/octopus/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248530572,"owners_count":21119600,"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":["communication","connection","decentralization","go","network","octopus","remote-access","remote-control","remote-shell","tool"],"created_at":"2024-08-01T02:01:16.829Z","updated_at":"2025-04-12T07:12:27.171Z","avatar_url":"https://github.com/snwfdhmp.png","language":"Go","funding_links":[],"categories":["Go","network"],"sub_categories":[],"readme":"[Octopus](#)\n======\n\n\u003e This project is still in development phase\n\nOctopus makes creation of decentralized networks super easy.\n\n----\n\n## Installation\n\nTODO: Describe the installation process\n\n## Getting started\n\n#### Verify installation\n Verify that octopus is installed by running `octopus --version` \n#### Create your node\n```\n$ octopus node create\nName: snwfdhmp\nPort (2048): \u003cEnter\u003e\n```\n#### Connect easily to other nodes\nYou can find a list of open nodes [here](#).\n\nOnce you've decided which node to connect to, run `octopus ts \u003cip\u003e \u003cport (default: 2048)\u003e`\n```\n$octopus ts 192.168.1.42\nConnecting to 192.168.1.42:2048...\nTap 192.168.1.42\nResponse token : 8d5faab2\nShake 192.168.1.42\nName media-center\nConnection successful to media-center\n```\n\n#### Start networking\nCreate your networks and add your nodes\n```\n$ octopus net home\nCreated network home\n$ octopus net home tap snwfdhmp\nInvited snwfdhmp to network 'home'\nsnwfdhmp joined 'home'\n```\n\nOr let you be tapped to existing networks\n```\n$ octopus logs\n...\n\u003e tap from 14.233.27.9 to dev-team\n...\n\n$ octopus nets\nNAME      STATUS\ndev-team  pending\nfriends   joined\nlocal     joined\n\n$ octopus join dev-team\nAccepted invitation to dev-team\nJoining dev-team\nConnect to (5/9) nodes...\n```\n\n\n#### DSNet Remote Shell\n\nYou can start a shell that will run on remote nodes ...\n\n```\n$ octopus sh media-center\nmedia-center\u003e echo $HOME\n/home/media\nmedia-center\u003e reboot\n\n$ octopus sh media-center \"echo $HOME\"\n/home/media\n```\n\n... or on an entire network\n```\n$ octopus sh local\nlocal\u003e echo $HOME\nmedia-center: /home/media\nsnwfdhmp: /Users/Martin\n```\n\n### Fusion several networks\n\nYou can fusion several networks to make a bigger one.\nThis will invite every node of each network to the new network created.\n\n```\n$ octopus net game -f home friends\nFusioning 'home' and 'friends' into 'game'\nhome/snwfdhmp joined\nfriends/lucas joined\nhome/NAS joined\nhome/webserver joined\nfriends/landry joined\n\n5 nodes in 'game'\n```\n\n### Access local machines remotely\n\nSituation: Lucas has 2 computers, each one running octopus.\n\nIts first computer (named \"lucas\") is connected to the internet.\n\nIts second computer (named \"second\") is just connected to LAN.\n\nYou're not connected to Lucas' LAN but you have octopus running connected to lucas' Node.\n\n```\n$ octopus ts second -w lucas\nAsking 'lucas' permission to access 'second'\n'lucas' sent token 3fa06a2d\nShake 192.168.12.56 through 'lucas'\nName second\nConnection successful to second through lucas\n\n$ octopus ping computer\nping ... OK (25ms)\n\n$ octopus sh computer\ncomputer\u003e ...\n```\n\n## [Duck](https://github.com/snwfdhmp/duck) integration\n\nWe're working on [duck](https://github.com/snwfdhmp/duck) integration.\n\nThis will permit to run lings on several machines.\n\n#### Example combination of [duck](https://github.com/snwfdhmp/duck) and [octopus](https://github.com/snwfdhmp/octopus)\n\nTODO: write usage examples (duck+octopus)\n\n## Contributing\n\n1. Fork it!\n2. Create your feature branch: `git checkout -b my-new-feature`\n3. Commit your changes: `git commit -am 'Add some feature'`\n4. Push to the branch: `git push origin my-new-feature`\n5. Submit a pull request :D\n\n## History\n\nTODO: Write history\n\n## Credits\n\nTODO: Write credits\n\n## License\n\nTODO: Write license\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnwfdhmp%2Foctopus","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsnwfdhmp%2Foctopus","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsnwfdhmp%2Foctopus/lists"}