wip
Some checks failed
/ mirror_to_github (push) Failing after 1m34s
/ test (push) Successful in 12s

This commit is contained in:
Leon van Kammen 2025-01-21 15:05:16 +01:00
parent 9451eda26a
commit 37fa95666f

View file

@ -21,7 +21,6 @@ See [the wiki here](https://forgejo.isvery.ninja/xrsh/xrsh/wiki/Home#milestones)
<details> <details>
<summary>run standalone binary</summary> <summary>run standalone binary</summary>
<br>
1. Download [xrsh.com](https://forgejo.isvery.ninja/xrsh/xrsh/raw/branch/main/xrsh.com) 1. Download [xrsh.com](https://forgejo.isvery.ninja/xrsh/xrsh/raw/branch/main/xrsh.com)
2. optional: run `unzip xrsh.com` to verify repository contents 2. optional: run `unzip xrsh.com` to verify repository contents
3. run `chmod +x xrsh.com` in your console (only linux/mac) 3. run `chmod +x xrsh.com` in your console (only linux/mac)
@ -32,7 +31,6 @@ See [the wiki here](https://forgejo.isvery.ninja/xrsh/xrsh/wiki/Home#milestones)
<details> <details>
<summary>install using nixos</summary> <summary>install using nixos</summary>
<br>
[NIX](https://nixos.org/) is a convenient way to install or develop xrsh: [NIX](https://nixos.org/) is a convenient way to install or develop xrsh:
1. `nix-shell -p xrsh thttpd` 1. `nix-shell -p xrsh thttpd`
@ -44,7 +42,6 @@ See [the wiki here](https://forgejo.isvery.ninja/xrsh/xrsh/wiki/Home#milestones)
<details> <details>
<summary>run OCI container [podman/docker]</summary> <summary>run OCI container [podman/docker]</summary>
<br>
1. `$(which podman || which docker) run -p 8080:8080 docker.io/coderofsalvation/xrsh` 1. `$(which podman || which docker) run -p 8080:8080 docker.io/coderofsalvation/xrsh`
2. point your browser to `localhost:8080` 2. point your browser to `localhost:8080`
3. profit! 3. profit!
@ -63,6 +60,32 @@ $ $(which podman || which docker) run -p 8080:8080 -v data/cert:etc/cert -v data
</details> </details>
<details>
<summary>run from codeberg.org (nonprofit-backed forgejo instance)</summary>
<br>
1. create a `pages` branchclone
2. push it to the codeberg repository
3. profit! it is now live
> more info: https://docs.codeberg.org/codeberg-pages/
</details>
<details>
<summary>run from selfhosted [forgejo](https://forgejo.org)/gitea codeforge-instance</summary>
<br>
1. clone the xrsh repository locally
2. create a repo on your forgejo instance
3. `git push` the xrsh to it
4. in your forgejo (docker/nix)-instance symlink it to the public folder (*)
5. point your browser to `https://yourforgejo.org/assets/xrsh`
> \* = for example: `ln -f git/repositories/yourusername/xrsh gitea/public/assets/.`
> optionally customize the [xrsh yunohost package](https://forgejo.isvery.ninja/xrsh/xrsh_ynh) with your own ISO
</details>
<details> <details>
<summary>install in [yunohost](https://yunohost.org)</summary> <summary>install in [yunohost](https://yunohost.org)</summary>
@ -74,6 +97,31 @@ $ $(which podman || which docker) run -p 8080:8080 -v data/cert:etc/cert -v data
> optionally customize the [xrsh yunohost package](https://forgejo.isvery.ninja/xrsh/xrsh_ynh) with your own ISO > optionally customize the [xrsh yunohost package](https://forgejo.isvery.ninja/xrsh/xrsh_ynh) with your own ISO
</details> </details>
<details>
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](https://forgejo.isvery.ninja/xrsh/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`)
<details>
<summary>build using shellscript</summary>
1. Run `./make standalone` to package everything into `xrsh.com`
</details>
<details> <details>
<summary>build using nix</summary> <summary>build using nix</summary>
@ -94,23 +142,6 @@ You can specify a different `.iso` file in various ways:
</details> </details>
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](https://forgejo.isvery.ninja/xrsh/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](https://forgejo.isvery.ninja/xrsh/xrsh-com) * development of components (`src/com`) takes places [in this git submodule](https://forgejo.isvery.ninja/xrsh/xrsh-com)
* development of `xrsh.iso` takes places [in this gitsubmodule](https://forgejo.isvery.ninja/xrsh/xrsh-buildroot) * development of `xrsh.iso` takes places [in this gitsubmodule](https://forgejo.isvery.ninja/xrsh/xrsh-buildroot)