Live at projectsegfau.lt.
You need a lot of infrastructure to run a complete version of the website including a Ghost CMS deployment.
- Install node.js.
- Install pnpm.
- Learn Svelte.
- Add the environment variables from the environment variables section.
- Clone the repository using
git clone https://github.com/ProjectSegfault/website. - Change directory into the clone using
cd ./website. - Install dependencies using
pnpm i. - Run the dev server using
pnpm dev. - Open a browser on
http://localhost:5173/and you should see the website running locally!
In production you can run the website through Docker Compose or locally. We strongly recommend using Docker since it makes everything 10 times easier.
First install Docker and Docker Compose on your system (use Linux if you are sane). After that add the environment variables from the environment variables section and run docker compose up -d in the directory of the source code (or just the compose.yml file if you aren't building from source). If you are using Portainer (if you aren't, start using it) you should add a new stack in the Stacks section and select the compose file option, then copy the compose.yml file.
If you want to run the website locally in production follow the steps in developing but use node build instead of pnpm dev and expect the website to be in http://localhost:3000.
The website has the following mandatory environment variables
| Name | Description |
|---|---|
| GHOST_URL | Your Ghost CMS URL |
| GHOST_API_KEY | Your Ghost CMS API key |
| GHOST_ALLPOSTS_URL | Your URL for all ghost posts, see below |
| KUMA_URL | Your Uptime Kuma announcements URL |
| ORIGIN | Your domain |
| ADDRESS_HEADER | Header used to retrieve client IP (Caddy only) |
GHOST_ALLPOSTS_URL should be of the form
https://GHOST_URL/ghost/api/content/posts/?key=GHOST_API_KEY&include=authors,tags&limit=all&formats=html,plaintext