You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
offline-octopus/README.md

36 lines
1.6 KiB

2 years ago
# Offtopus, offline-octopus
2 years ago
2 years ago
## Goal
2 years ago
Provide a way to connect local machines to work and tinker with efficiently, building prototypes with resilience in mind.
2 years ago
## How does it work
2 years ago
It provides a Web server with endpoints for different functions, including listing machines joining that network, make functions available to that new network of machines, sharing files, etc. Note that the point is to build on top of it, consequently functions as endpoints here are solely examples.
2 years ago
## How to install
1. clone repository
1. install dependancies (no package.json yet) but mostly express missing, i.e `npm i express`
1. run e.g `node .`
1. connect to it locally first, e.g https://localhost:8082 (assumes existing SSL certificates) or https://localhost:8082/routes
2 years ago
Note that the cloudinit file is an example on a brand new machine.
2 years ago
### tested on
2 years ago
- Linux machines, e.g Ubuntu on desktop, RPi Zero
- Android devices using Termux, e.g Quest 1
- iOS via iSH
Most likely partially works on Windows with Linux subsystem. System commands, e.g shutdown, xrandr, etc must be adapted.
2 years ago
### Developing and debugging
2 years ago
- See the console REPL, starting with help()
- see `/routes/json` to connect to all services
2 years ago
## Digging deeper
2 years ago
- hour long video discussion https://video.benetou.fr/w/aR81WVHg6H3E93GPG4jYUg
- self hosting AI notes https://fabien.benetou.fr/Content/SelfHostingArtificialIntelligence
- self hosting subreddit https://old.reddit.com/r/selfhosted/
- small Web https://ar.al/2020/08/07/what-is-the-small-web/
- DWeb https://en.wikipedia.org/wiki/Decentralized_web
2 years ago
2 years ago
### Inspiration
2 years ago
- Xerox park paper on services making themselves available, coauthor including Trevor F Smith