The goal of this platform is provide an centralised knowledge base, primarily for my self and colleagues. Although I am sure, some of this will be useful to the wider community.
- Hosted over at https://docs.sdj.pw
- Built with VitePress
Custom Search Engines are where you enter a set keyphrase into the omnibar followed by a tab, and it will search directly that site. For example, I configure sdj as the phrase, so if i enter sdj<tab>varnish. It will navigate me directly to the search page of this site displaying varnish content.
- Clone the repository
git clone https://github.com/samjuk/docs.sdj.pw . && cd docs.sdj.pw/- Install the requirements
npm ci- Start the local development server
make dev- View at http://localhost:5173
Production build and deployment is taken care of by CI (Github Actions). The following variables need to be set on the project.
| Type | Name | Description |
|---|---|---|
| SECRET | SSH_PRIVATE_KEY |
SSH Private key that is authorised to connect to the remote host |
| SECRET | SSH_KNOWN_HOSTS |
Known host entry for the remote host |
| SECRET | REMOTE_HOST |
Username & Host for the remote host |
| SECRET | REMOTE_PATH |
Absolute Path to the web root on the remote host |
| SECRET | CLOUDFLARE_CACHE_ZONE |
Cache Zone to flush during deployments |
| SECRET | CLOUDFLARE_CACHE_TOKEN |
API Token with permissions to flush the relevant zone |
| SECRET | DISCORD_WEBHOOK_ID |
Webhook ID for deployment notifications |
| SECRET | DISCORD_WEBHOOK_TOKEN |
Webhook Token for deployment notifications |