Leon van Kammen 81c7136413 | ||
---|---|---|
.forgejo/workflows | ||
.github/workflows | ||
nix | ||
src | ||
.args | ||
.gitignore | ||
.gitmodules | ||
LICENSE | ||
README.md | ||
cosmopolitan.nix | ||
index.html | ||
make | ||
result | ||
shell.nix | ||
tags | ||
xrsh.com | ||
xrsh.com.txt | ||
xrsh.iso | ||
xrsh.nix | ||
xrsh.txt |
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:
- run
nix-run -p xrsh --run "xrsh.com"
(pass-p XXXX
to specify non-default 8080 port ) - build it when package does not exist:
nix-build -E "with import <nixpkgs> { }; callPackage ./xrsh.nix"
install without nix
- Download xrsh.com
- optional: run
unzip xrsh.com
to verify repository contents - run
chmod +x xrsh.com
in your console (only linux/mac) - run
./xrsh.com
in (any) shell - Profit! ✔
launch different .iso / modify files
You can specify a different .iso
file in various ways:
- open the
xrsh.com
as a zip (drag-drop into a zip-manager, or add.zip
extension) - method 1: overwrite
xrsh.iso
- method 2: open
src/index.html
and changeisoterminal="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
- development of components (
src/com
) takes places in this git submodule - development of
xrsh.iso
takes places in this gitsubmodule
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.