Skip to content

SamJUK/docs.sdj.pw

Repository files navigation

DOCS.SDJ.PW

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.

Configuring as a Custom Search Engine

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.

Example of a custom search Engine

Local Development

  1. Clone the repository
git clone https://github.com/samjuk/docs.sdj.pw . && cd docs.sdj.pw/
  1. Install the requirements
npm ci
  1. Start the local development server
make dev
  1. View at http://localhost:5173

Building Production

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