https://github.com/matrixai/polykey-network-dashboard
Polykey Network Dashboard
https://github.com/matrixai/polykey-network-dashboard
cybersecurity dashboard peer-to-peer visualization
Last synced: 9 months ago
JSON representation
Polykey Network Dashboard
- Host: GitHub
- URL: https://github.com/matrixai/polykey-network-dashboard
- Owner: MatrixAI
- License: gpl-3.0
- Created: 2023-12-04T02:33:03.000Z (about 2 years ago)
- Default Branch: staging
- Last Pushed: 2024-09-18T03:51:34.000Z (over 1 year ago)
- Last Synced: 2024-09-18T06:56:14.997Z (over 1 year ago)
- Topics: cybersecurity, dashboard, peer-to-peer, visualization
- Language: TypeScript
- Homepage: https://mainnet.polykey.com
- Size: 874 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Polykey-Network-Dashboard
Network dashboard for Polykey.
## About
This uses Docusaurus as a CMS.
GitHub builds this site via the CI/CD into static pages, rendering the markdown files.
The CI/CD then pushes it to [testnet.polykey.com](https://testnet.polykey.com) and [mainnet.polykey.com](https://mainnet.polykey.com) which is hosted by Cloudflare's worker system.
## Development
Run `nix develop`, and once you're inside, you can use:
```sh
# starts a local version
npm run start
# build the the static site
npm run build
# deploy to cloudflare
npm run deploy
# lint the source code
npm run lint
# automatically fix the source
npm run lintfix
```
You need to do setup the `.env` from `.env.example` if you want to successfully deploy to Cloudflare.
We use Git LFS to store all media in `images/**`. It's important to ensure that `git-lfs` is installed on your system before you contribute anything (on NixOS, it is installed as a separate package to `git`). By default anything put under `images/**` when using `git add` (after LFS is setup) will be uploaded to LFS, and thus the repository will only have links. Because LFS is enabled, it is used on GitHub.
If this is the first time you cloned the repository, you must use `git lfs install` to ensure your local repository has LFS setup. It may be automatically setup if you already had it installed prior to cloning.
Pro-tip, if we need to make sure files that were accidentally not put into LFS must be put into LFS, the command to use is:
```sh
git lfs migrate import --include="images/**" --everything
```
## Contributing
Because we use docusaurus, we can choose to write in markdown, TSX or MDX.
### Pages
Create a new markdown file in `/pages`. See the other files for formatting.
Note that some pages were not able to be put into `/pages` due to to more complex coding. These are in the `/src`.
### HTML Syntax
Sometimes markdown syntax just doesn't cut it, and HTML syntax needs to be used.
While `docusaurus` is flexible, GitHub is not.
GitHub will process the markdown and then sanitizes the HTML: https://github.com/github/markup#github-markup.
There is a limited set of HTML tags are here: https://github.com/gjtorikian/html-pipeline/blob/03ae30d713199c2562951d627b98b75dc16939e4/lib/html/pipeline/sanitization_filter.rb#L40-L49
Furthermore not all attributes are kept. The `style` attribute for example is filtered out.
The most common styling attributes to be used will most likely be `align`, `width`, and `height`. See: https://davidwells.io/snippets/how-to-align-images-in-markdown
### Linking Assets (files, images)
Markdown supports 2 ways of referencing images:
```md
```
The former is markdown syntax, the latter is HTML tag.
In order to maintain portability, we always use absolute paths. This works on both GitHub markdown rendering and also for `docusaurus`.
On GitHub, which renders the markdown directly, the relative paths are considered relative to the location of the markdown file referencing the path. The absolute paths are considered relative to the root of the project repository. Therefore because `images` directory is located at the project root, it ends up being routable.
With `docusaurus`, the absolute paths are looked up relative to `static` directory. Inside the `static` directory we have created symlinks pointing back to `../images`. This allows `docusaurus` to also resolve these paths which will be copied into the `/build/` directory.
Note that `docusaurus` doesn't do any special rendering for HTML tags, it uses the `src` as is. While markdown references will be further processed with webpack. It is therefore preferable to use markdown syntax instead. The `docusaurus` does support a variant of the HTML tag:
```md
.default})
```
However this does not work in GitHub. So this is not recommended to use.
Therefore if you want to add inline styles to an image and still use markdown syntax so you get the benefit of `docusaurus` asset processing, the styles must be applied outside the image reference in a surrounding tag:
```md
```
Take note of the whitespace newlines between, if no newlines are used, GitHub will interpret this as all HTML. Also note that `
` will not work.
Note that this won't work for resizing the images unfortunately. You have to apply the `width` attribute directly to the `![]()
` tag. See: https://github.com/facebook/docusaurus/discussions/6465 for more information.
### Linking
In the navigation in Docusaurus, there are several properties that controls how the routing works. Because `polykey.com` is composed of separate cloudflare workers stitched together into a single domain, we have to hack around client side routing even for what looks like relative links.
```js
{
to: 'pathname:///docs/',
target: '_self'
}
```
The `to` ensures it shows up as a relative link.
The `pathname://` bypasses the client side routing forcing server side routing.
The `target: '_self'` ensures that the same frame is used instead of creating a new frame.
## Deployment
You need to setup `.env` from `.env.example`.
Then you can build `npm run build`.
Finally run `npm run deploy`.
This will deploy the development workers first.
If you want to deploy production workers, you have to `npm run deploy -- --env production`.
### DNS
DNS is managed by cloudflare. The `wrangler.toml` specifies the usage of a custom domain for the worker that runs this static site.
The entire built `public` directory gets uploaded to cloudflare's KV system.
The custom domain is then added as a special record on the `testnet.polykey.com` and `mainnet.polykey.com` zone which routes directly to the worker service.
Finally HTTPS is always on, so there's a redirection from `http` to `https` too.
Traditionally without the custom domain, you would have to use worker routes. However this only works if you also create a A record for the root with the proxy-mode turned on. The actual address doesn't matter, you can point it to a private or reserved IP, maybe even `127.0.0.1` because once the proxy is activated, the worker routes take effect.