Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions .github/workflows/check.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,3 @@ jobs:
- name: "Check, Test and Build Application"
run: |
nix develop --command bash -c "cabal update --ignore-project && cabal dev-test-build"

- name: "Check, Test and Build Website"
run: |
nix develop --command bash -c "cd website && npm install && npm run check"
69 changes: 0 additions & 69 deletions .github/workflows/website.yml

This file was deleted.

1 change: 0 additions & 1 deletion .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,3 @@ CHANGELOG.md
dist-newstyle/
dist/
nix/
website/
5 changes: 2 additions & 3 deletions AGENTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
- `app/Main.hs` wires the CLI entrypoint; `scripts/` stores POSIX sh snippets
shipped to hosts, review `scripts/README.md` before changes.
- Tests live in `test/doctest` and `test/spec`; mirror source structure when
adding specs. `nix/` handles tooling, `website/` contains the Next.js-based
Website source-code.
adding specs. `nix/` handles tooling.

## Build, Test, and Development Commands

Expand Down Expand Up @@ -47,7 +46,7 @@
- Every commit must pass `cabal dev-test-build` and include generated or
formatted artifacts.
- Pull requests need a concise summary, validation notes, linked issues (e.g.
`Closes #42`), and UI screenshots when touching `website/`.
`Closes #42`).

## Remote Script Safety

Expand Down
40 changes: 25 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,22 @@
<h1 align="center">
<div>
<img alt="logo" src="https://github.com/vst/hostpatrol/assets/374793/cad6706b-0384-4a71-9ca5-21ade9ce3d1e" />
<img alt="Host Patrol Icon" src="https://media.hostpatrol.io/site/meta/icon-dark.svg" width="180" />
</div>
<div>Host Patrol</div>
<sub>Lazy Hacker's Linux Host Patrol</sub>
<p></p>
<div>HOST PATROL</div>
<div>
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/vst/hostpatrol?display_name=tag&style=for-the-badge">
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues/vst/hostpatrol?style=for-the-badge">
<img alt="GitHub Issues or Pull Requests" src="https://img.shields.io/github/issues-pr/vst/hostpatrol?style=for-the-badge">
<sub>Lazy Hacker's Linux Host Patrol</sub>
</div>
<div>
<sub>
<a href="https://www.hostpatrol.io">Website</a> •
<a href="https://console.hostpatrol.io">Console</a>
<sub>
</div>
<div>
<img alt="GitHub Release" src="https://img.shields.io/github/v/release/vst/hostpatrol?display_name=tag&style=flat-square" />
<img alt="GitHub Issues" src="https://img.shields.io/github/issues/vst/hostpatrol?style=flat-square" />
<img alt="Pull Requests" src="https://img.shields.io/github/issues-pr/vst/hostpatrol?style=flat-square" />
<img alt="CI Status" src="https://img.shields.io/github/actions/workflow/status/vst/hostpatrol/check.yaml?style=flat-square" />
</div>
</h1>

Expand All @@ -17,7 +25,7 @@
Host Patrol (`hostpatrol`) is a command-line application to retrieve information
from remote hosts. The information is retrieved over SSH by executing small
[scripts]. Then, the information is compiled into JSON to be further analysed or
visualised on its [Website].
visualised on [Host Patrol Console Application][console].

The report contains following information for each host:

Expand Down Expand Up @@ -145,14 +153,15 @@ hostpatrol compile --config config.yaml > /tmp/hostpatrol-report.json
hostpatrol compile --config config.yaml --host a-host --host b-host > /tmp/hostpatrol-report.json
```

Users can process/analyse the JSON output themselves or use [Website] to list,
tabulate and visualise the information.
Users can process/analyse the JSON output themselves or use [Host Patrol Console
Application][console] to list, tabulate and visualise the information.

> [!NOTE]
>
> The [Website] stores the report locally in the Web browser using local
> storage. It is not sent to any third party service. You can study the [source]
> of the Website that is automatically published to GitHub Pages.
> The [console] application stores the report locally in the Web browser using
> local storage. It is not sent to any third party service. You can study the
> [source code of the console application][console-source] that is automatically
> published to GitHub Pages.

## Development

Expand Down Expand Up @@ -191,9 +200,10 @@ Copyright &copy; 2024-2025 Vehbi Sinan Tunalioglu. This work is licensed under
<!-- REFERENCES -->

[Issue 32]: https://github.com/vst/hostpatrol/issues/32
[Website]: https://hostpatrol.io
[website]: https://www.hostpatrol.io
[console]: https://console.hostpatrol.io
[console-source]: https://github.com/vst/hostpatrol-console
[os-release]:
https://www.freedesktop.org/software/systemd/man/latest/os-release.html
[scripts]: ./scripts
[source]: ./website
[MIT License]: https://opensource.org/license/mit
1 change: 0 additions & 1 deletion flake.nix
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,6 @@
pkgs.nil
pkgs.nixpkgs-fmt
pkgs.nodePackages.prettier
pkgs.nodejs_22
pkgs.upx

## Our development and testing scripts:
Expand Down
6 changes: 0 additions & 6 deletions website/.eslintrc.json

This file was deleted.

38 changes: 0 additions & 38 deletions website/.gitignore

This file was deleted.

29 changes: 0 additions & 29 deletions website/README.md

This file was deleted.

35 changes: 0 additions & 35 deletions website/next.config.mjs

This file was deleted.

Loading