Skip to content

Latest commit

 

History

History
68 lines (45 loc) · 1.72 KB

contributing.md

File metadata and controls

68 lines (45 loc) · 1.72 KB
Raw

Contributing

Requirements

  • Docker
  • Node.js

Setting up the development environment

  1. Start the services
docker compose up -d

  1. Copy .env.example to .env

  2. Go to https://authentik.localhost/if/flow/initial-setup/ and create admin account

  3. Click on Admin interface button on the top right corner and login with the admin account Admin interface

  4. Go to Applications > Providers and create a new provider

  5. Select OAuth2/OpenID Provider and click Next

  6. Fill in the details and Take note of the Client ID and Client secret! Create provider

  7. Set OIDC_CLIENT_ID and OIDC_CLIENT_SECRET in .env file

OIDC_CLIENT_ID=your_client_id
OIDC_CLIENT_SECRET=your_client_secret

  1. Then go to Applications > Applications and create a new application (select the provider you created in the previous steps) Create applications

  2. Set PTERODACTYL_URL to the root URL of your Pterodactyl instance

  3. Set PTERODACTYL_APP_API_KEY to the application API key of your Pterodactyl instance (generated in the admin panel)

  4. Set PTERODACTYL_USER_API_KEY to the user API key of your Pterodactyl instance (generated in the user panel)

  5. Set PTERODACTYL_USER_ID to the same user id as the user API key

  6. Set PTERODACTYL_ALLOWED_NODES to the node ids seperated with a comma (e.g. 1,2,3) that the backend is allowed to use

  7. Install the dependencies

npm run i
  1. Generate the Prisma client
npm run prisma:generate
  1. Push the database schema to the database
npm run prisma:push
  1. Start the development server
npm run dev