Giter Club home page Giter Club logo

website-1's Introduction

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)

website-1's People

Contributors

akisblack avatar arboygo avatar arnau478 avatar dependabot[bot] avatar gi-yt avatar midou36o avatar mrlerien avatar pistasjis avatar supercolbat avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.