Go to file
Leon van Kammen 81c7136413
/ mirror_to_github (push) Failing after 40s Details
/ test (push) Successful in 9s Details
temporary remove xrsh-buildroot subrepo
2024-10-31 17:47:49 +01:00
.forgejo/workflows mirror_to_github action++++++ 2024-04-30 14:55:48 +02:00
.github/workflows GH action 2024-05-30 14:50:23 +00:00
nix made make-script compatible with nix 2024-10-28 11:12:18 +00:00
src temporary remove xrsh-buildroot subrepo 2024-10-31 17:47:49 +01:00
.args build fix: now opens browser correctly 2024-09-24 11:07:14 +00:00
.gitignore main: minor bugfix 2024-07-23 13:17:10 +00:00
.gitmodules temporary remove xrsh-buildroot subrepo 2024-10-31 17:47:49 +01:00
LICENSE Initial commit 2023-11-01 11:14:44 +01:00
README.md main: update documentation 2024-10-28 15:09:46 +00:00
cosmopolitan.nix made make-script compatible with nix 2024-10-28 11:12:18 +00:00
index.html updated docs with editors 2024-10-31 16:15:18 +01:00
make make typofix 2024-10-28 14:13:06 +00:00
result made make-script compatible with nix 2024-10-28 11:12:18 +00:00
shell.nix added tests/gifs with vhs 2024-08-26 19:57:35 +00:00
tags made make-script compatible with nix 2024-10-28 11:12:18 +00:00
xrsh.com made make-script compatible with nix 2024-10-28 11:12:18 +00:00
xrsh.com.txt made make-script compatible with nix 2024-10-28 11:12:18 +00:00
xrsh.iso added xrsh-buildroot submodule 2024-10-30 15:46:08 +00:00
xrsh.nix made make-script compatible with nix 2024-10-28 11:12:18 +00:00
xrsh.txt made make-script compatible with nix 2024-10-28 11:12:18 +00:00

README.md

xrsh

Wiki / Roadmap

See the wiki here

Install

NOTE: installation is optional: just surf to the public version here

install using nix

NIX is a convenient way to install or develop xrsh:

  1. run nix-run -p xrsh --run "xrsh.com" (pass -p XXXX to specify non-default 8080 port )
  2. build it when package does not exist: nix-build -E "with import <nixpkgs> { }; callPackage ./xrsh.nix"
install without nix
  1. Download xrsh.com
  2. optional: run unzip xrsh.com to verify repository contents
  3. run chmod +x xrsh.com in your console (only linux/mac)
  4. run ./xrsh.com in (any) shell
  5. Profit! ✔
launch different .iso / modify files

You can specify a different .iso file in various ways:

  1. open the xrsh.com as a zip (drag-drop into a zip-manager, or add .zip extension)
  2. method 1: overwrite xrsh.iso
  3. method 2: open src/index.html and change isoterminal="iso: ./../xrsh.iso" to another file/URL

see developer-section below on building your own iso

The browser auto-launches https://localhost:8080 on most platforms

pass -p XXXX to specify port (default:8080)

Developers

Make sure to clone the repo including submodules (the xrsh-com repo)

$ git clone --recurse-submodules https://forgejo.isvery.ninja/xrsh/xrsh
$ cd xrsh
$ nix-shell  # optional but adviced (to get up and running instantly)

Now serve the repo from a HTTPS webserver (for example run ./make dev)

Run ./make standalone to package everything into xrsh.com

Funding

This project is funded through NGI0 Entrust, a fund established by NLnet with financial support from the European Commission's Next Generation Internet program. Learn more at the NLnet project page.

NLnet foundation logo NGI Zero Logo