because i fucking hate myself.
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
ARBoyGo 36bb797516
Update simplelogin.svg (#100)
3 days ago
.github/workflows better navbar 2 months ago
src add back plausible 1 week ago
static Update simplelogin.svg (#100) 3 days ago
.dockerignore docker 7 months ago
.gitignore v3 2 months ago
.npmrc v3 2 months ago
.prettierignore push initial rewrite (already prod ready!) 9 months ago
.prettierrc v3 2 months ago
Dockerfile improve docs (closes #94) 2 months ago
LICENSE add mit license 8 months ago
README.md add ip header to README 1 month ago
compose.yml upper case P & S makes docker compose freak out 1 month ago
package.json v3 2 months ago
pnpm-lock.yaml v3 2 months ago
svelte.config.js better navbar 2 months ago
tsconfig.json v3 2 months ago
uno.config.ts new nav 4 weeks ago
vite.config.ts better navbar 2 months ago

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)