because i fucking hate myself.
Go to file
Arya 411f10bd57
Initial short url support in /instances (#103)
2023-06-11 19:28:04 +03:00
.github/workflows better navbar 2023-02-03 19:55:33 +02:00
src Initial short url support in /instances (#103) 2023-06-11 19:28:04 +03:00
static add healthchecks and soju 2023-05-30 13:05:23 +08:00
.dockerignore docker 2022-08-27 19:38:41 +03:00
.gitignore v3 2023-01-25 19:11:11 +02:00
.npmrc v3 2023-01-25 19:11:11 +02:00
.prettierignore push initial rewrite (already prod ready!) 2022-06-17 21:52:07 +03:00
.prettierrc v3 2023-01-25 19:11:11 +02:00
Dockerfile improve docs (closes #94) 2023-01-10 20:58:52 +02:00
LICENSE add mit license 2022-08-04 20:35:27 +03:00
README.md add ip header to README 2023-02-18 15:01:27 +05:30
compose.yml upper case P & S makes docker compose freak out 2023-02-17 21:52:18 +05:30
package.json Add support to markdown 2023-06-09 15:34:35 +01:00
pnpm-lock.yaml Add support to markdown 2023-06-09 15:34:35 +01:00
svelte.config.js better navbar 2023-02-03 19:55:33 +02:00
tsconfig.json v3 2023-01-25 19:11:11 +02:00
uno.config.ts Initial short url support in /instances (#103) 2023-06-11 19:28:04 +03:00
vite.config.ts better navbar 2023-02-03 19:55:33 +02:00

README.md

Project Segfault website

Live at projectsegfau.lt.

Developing

You need a lot of infrastructure to run a complete version of the website including: Ghost CMS deployment and Authentik authentication.

Prerequisites

Running a dev server.

  1. Clone the repository using git clone https://github.com/ProjectSegfault/website.
  2. Change directory into the clone using cd ./website.
  3. Install dependencies using pnpm i.
  4. Run the dev server using pnpm dev.
  5. Open a browser on http://localhost:5173/ and you should see the website running locally!

Running in production

In production you can run the website through Docker Compose or locally. We strongly recommend using Docker since it makes everything 10 times easier.

Docker

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.

Locally

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.

Environment variables

The website has the following mandatory environment variables

Name Description
AUTH_CLIENT_ID Authentik client ID
AUTH_CLIENT_SECRET Authentik client secret
AUTH_ISSUER Authentication issuer URL
AUTH_TRUST_HOST Your domain
AUTH_SECRET Random 32 char secret
GHOST_URL Your Ghost CMS URL
GHOST_API_KEY Your Ghost CMS API key
KUMA_URL Your Uptime Kuma announcements URL
ORIGIN Your domain
ADDRESS_HEADER Header used to retrieve client IP (Caddy only)