README.md

# Offtopus, offline-octopus

## Goal
Provide a way to connect local machines to work and tinker with efficiently, building prototypes with resilience in mind.

## Demo

5min recorded demo video https://video.benetou.fr/w/sHE39WSZkQgfPNDdiypfog

Note that XR is optional. Original extract from https://youtu.be/BRjohy0ruAg?t=2061 for Future of Text demo day.

## How does it work
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.

## 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

Note that the cloudinit file is an example on a brand new machine.

### tested on
- 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.

### Developing and debugging
- See the console REPL, starting with help()
- see `/routes/json` to connect to all services

## Digging deeper
- Future of Text WebXR demo with shared filesystems https://video.benetou.fr/w/h291CfZiezenY1t46cQQo5 extract from https://www.youtube.com/results?search_query=demo+prototype+session
- 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

### Inspiration
- Designing for serendipity: supporting end-user configuration of ubiquitous computing environments, Xerox PARC 2002
- Providing an Integrated User Experience of Networked Media, Devices, and Services through End-User Composition, 2008
readme fix 2023-10-27 16:43:31 +02:00			`# Offtopus, offline-octopus`
readme 2023-10-27 16:41:00 +02:00
readme fix 2023-10-27 16:43:31 +02:00			`## Goal`
readme 2023-10-27 16:41:00 +02:00			`Provide a way to connect local machines to work and tinker with efficiently, building prototypes with resilience in mind.`

demo day video 2023-10-28 11:03:40 +02:00			`## Demo`

			`5min recorded demo video https://video.benetou.fr/w/sHE39WSZkQgfPNDdiypfog`

			`Note that XR is optional. Original extract from https://youtu.be/BRjohy0ruAg?t=2061 for Future of Text demo day.`

readme fix 2023-10-27 16:43:31 +02:00			`## How does it work`
readme 2023-10-27 16:41:00 +02:00			`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.`

readme fix 2023-10-27 16:43:31 +02:00			`## 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`
readme 2023-10-27 16:41:00 +02:00
			`Note that the cloudinit file is an example on a brand new machine.`

readme fix 2023-10-27 16:43:31 +02:00			`### tested on`
readme 2023-10-27 16:41:00 +02:00			`- 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.`

readme fix 2023-10-27 16:43:31 +02:00			`### Developing and debugging`
readme 2023-10-27 16:41:00 +02:00			`- See the console REPL, starting with help()`
			- see `/routes/json` to connect to all services

readme fix 2023-10-27 16:43:31 +02:00			`## Digging deeper`
videos 2023-10-27 17:07:35 +02:00			`- Future of Text WebXR demo with shared filesystems https://video.benetou.fr/w/h291CfZiezenY1t46cQQo5 extract from https://www.youtube.com/results?search_query=demo+prototype+session`
more refs 2023-10-27 17:01:09 +02:00			`- 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`
readme 2023-10-27 16:41:00 +02:00
readme fix 2023-10-27 16:43:31 +02:00			`### Inspiration`
publications 2023-10-27 17:03:20 +02:00			`- Designing for serendipity: supporting end-user configuration of ubiquitous computing environments, Xerox PARC 2002`
			`- Providing an Integrated User Experience of Networked Media, Devices, and Services through End-User Composition, 2008`