{"id":18084830,"url":"https://github.com/coderofsalvation/xrsh","last_synced_at":"2025-04-06T00:13:25.728Z","repository":{"id":204865848,"uuid":"712845491","full_name":"coderofsalvation/xrsh","owner":"coderofsalvation","description":"WebXR terminal console ISO-runtime for THREE/AFRAME [mirror of https://forgejo.isvery.ninja/xrsh/xrsh]","archived":false,"fork":false,"pushed_at":"2025-01-20T20:51:58.000Z","size":186702,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-04-04T14:40:13.051Z","etag":null,"topics":["aframe","console","terminal","three","webxr"],"latest_commit_sha":null,"homepage":"https://xrsh.isvery.ninja","language":"HTML","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/coderofsalvation.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2023-11-01T10:14:44.000Z","updated_at":"2025-01-20T20:52:03.000Z","dependencies_parsed_at":"2023-12-31T22:51:58.280Z","dependency_job_id":"5de8fa33-86f7-4132-a61f-a6b228c3fa93","html_url":"https://github.com/coderofsalvation/xrsh","commit_stats":null,"previous_names":["coderofsalvation/webxros","coderofsalvation/xrsh"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fxrsh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fxrsh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fxrsh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/coderofsalvation%2Fxrsh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/coderofsalvation","download_url":"https://codeload.github.com/coderofsalvation/xrsh/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247415976,"owners_count":20935387,"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":["aframe","console","terminal","three","webxr"],"created_at":"2024-10-31T15:08:23.066Z","updated_at":"2025-04-06T00:13:25.695Z","avatar_url":"https://github.com/coderofsalvation.png","language":"HTML","readme":"# xrsh\n\n\u003cimg src='xrsh.svg' width=\"25%\"/\u003e\n\n## [click here for the website / hosted repo](https://xrsh.isvery.ninja)\n\n## XRSH Manual \n\nDocumentation for XRSH users can be found [here](https://forgejo.isvery.ninja/xrsh/xrsh-buildroot/src/branch/main/buildroot-v86/board/v86/rootfs_overlay/root/manual.md)\n\n\u003e TIP: this is also available by typing `ctrl/cmd+a+0` or `man xrsh` inside XRSH\n\n## Wiki / Roadmap\n\nSee [the wiki here](https://forgejo.isvery.ninja/xrsh/xrsh/wiki/Home#milestones)\n\n## Install \n\n\u003e NOTE: installation is optional: just surf to the public version [here](https://xrsh.isvery.ninja)\n\n\u003cdetails\u003e\n    \u003csummary\u003erun standalone binary\u003c/summary\u003e\n\n1. Download [xrsh.com](https://forgejo.isvery.ninja/xrsh/xrsh/raw/branch/main/xrsh.com)\n2. optional: run `unzip xrsh.com` to verify repository contents\n3. run `chmod +x xrsh.com` in your console (only linux/mac)\n4. run `./xrsh.com` in (any) shell\n5. Profit! ✔\n\u003c/details\u003e\n\u003cdetails\u003e\n\u003csummary\u003einstall using nixos\u003c/summary\u003e\n\n[NIX](https://nixos.org/) is a convenient way to install or develop xrsh:\n\n1. `nix-shell -p xrsh thttpd`\n2. `thttpd -p 8080 -d /nix/store/5q4vd50gmh52jh48z62ln1j05xzfh1fz-xrsh-0.142`\n3. point your browser to `localhost:8080`\n4. profit!\n\u003c/details\u003e\n\n\u003csummary\u003erun OCI container [podman/docker]\u003c/summary\u003e\n\u003cdetails\u003e\n\n1. `$(which podman || which docker) run -p 8080:8080 docker.io/coderofsalvation/xrsh`\n2. point your browser to `localhost:8080`\n3. profit!\n\n\u003e NOTE 1: to add files use the `-D \u003cdir\u003e` overlay webroot parameter.\n\n\u003e NOTE 2: to enable SSL and add (iso)file try something like this:\n\n```\n$ mkdir data\n$ cp ../xrsh.iso data/. # copy custom iso\n$ $(which podman || which docker) run -p 8080:8080 -v data/cert:etc/cert -v data:/data docker.io/coderofsalvation/xrsh /xrsh.com -D /data -c 0 -C /etc/cert/cert.pem -K /etc/cert/key.pem\n```\n\n\u003e or as an exercise in constructive laziness setup a reverse proxy like [zoraxy](https://github.com/tobychui/zoraxy), [go-proxy](https://github.com/yusing/go-proxy), [droxy], caddy or nginx-reverse-proxymanager.   \n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003einstall in yunohost\u003c/summary\u003e\n\n1. search for xrsh in the application catalog \n2. click install\n3. profit!\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003ebuild using nix\u003c/summary\u003e\n\n1. `nix-build -E \"with import \u003cnixpkgs\u003e { }; callPackage ./nix/xrsh-package.nix\"`\n2. optionally see the other nix-files in `nix`-folder\n\u003c/details\u003e\n\n\u003cdetails\u003e\n    \u003csummary\u003elaunch different .iso / modify files\u003c/summary\u003e\n\nYou can specify a different `.iso` file in various ways:\n\n1. open the `xrsh.com` as a zip (drag-drop into a zip-manager, or add `.zip` extension) \n2. method 1: overwrite `xrsh.iso`\n3. method 2: open `src/index.html` and change `isoterminal=\"iso: ./../xrsh.iso\"` to another file/URL\n\n\u003e see developer-section below on building your own iso\n\n\u003c/details\u003e\n\nThe browser auto-launches `https://localhost:8080` on most platforms\n\n\u003e pass `-p XXXX` to specify port (default:8080)\n\n## Developers \n\nMake sure to clone the repo including submodules (the [xrsh-com](https://forgejo.isvery.ninja/xrsh/xrsh-com) repo)\n\n```\n$ git clone --recurse-submodules https://forgejo.isvery.ninja/xrsh/xrsh\n$ cd xrsh\n$ nix-shell  # optional but adviced (to get up and running instantly)\n```\n\n\u003e Now serve the repo from a HTTPS webserver (for example run `./make dev`)\n\nRun `./make standalone` to package everything into `xrsh.com`\n\n* development of components (`src/com`) takes places [in this git submodule](https://forgejo.isvery.ninja/xrsh/xrsh-com)\n* development of `xrsh.iso` takes places [in this gitsubmodule](https://forgejo.isvery.ninja/xrsh/xrsh-buildroot)\n\n\n## Funding\n\nThis project is funded through [NGI0 Entrust](https://nlnet.nl/entrust), a fund established by [NLnet](https://nlnet.nl) with financial support from the European Commission's [Next Generation Internet](https://ngi.eu) program. Learn more at the [NLnet project page](https://nlnet.nl/project/xrsh).\n\n[\u003cimg src=\"https://nlnet.nl/logo/banner.png\" alt=\"NLnet foundation logo\" width=\"20%\" /\u003e](https://nlnet.nl)\n[\u003cimg src=\"https://nlnet.nl/image/logos/NGI0_tag.svg\" alt=\"NGI Zero Logo\" width=\"20%\" /\u003e](https://nlnet.nl/entrust)\n\n## Inspired by\n\n* [mimetype hooks](https://forgejo.isvery.ninja/xrsh/xrsh-buildroot/src/branch/main/buildroot-v86/board/v86/rootfs_overlay/root/hook.d/mimetype): [Future of Text's](https://github.com/TheElectronicLiteratureLab/spasca-fsbased-interrop-companion/)\n* [xterm](https://invisible-island.net/xterm/)\n* [xr-terminal](https://github.com/RangerMauve/xr-terminal) of Mauve (an amazingly talented dev)\n* [Fabien Beneout's PIM](https://fabien.benetou.fr/) (the WIKI containing all secrets \u0026 ideas in life)\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderofsalvation%2Fxrsh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcoderofsalvation%2Fxrsh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcoderofsalvation%2Fxrsh/lists"}