awatertrevi/infisical
1
0
Fork 0
mirror of https://github.com/awatertrevi/infisical.git synced 2026-09-22 13:39:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

Refactor envars for easier self-hosting

Browse Source
This commit is contained in:
Tuan Dang
2022-11-20 22:54:38 -05:00
parent 0f6675942d
commit 896760903a
12 changed files with 66 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
Makefile
View File

@@ -5,10 +5,10 @@ push:
docker-compose -f docker-compose.yml push docker-compose -f docker-compose.yml push
up-dev: up-dev:
docker-compose -f docker-compose.dev.yml up docker-compose -f docker-compose.dev.yml up --build
up-prod: up-prod:
docker-compose -f docker-compose.yml up docker-compose -f docker-compose.yml up --build
down: down:
docker-compose down docker-compose down

2
backend/environment.d.ts vendored
View File

@@ -21,6 +21,7 @@ declare global {
PRIVATE_KEY: string; PRIVATE_KEY: string;
PUBLIC_KEY: string; PUBLIC_KEY: string;
SENTRY_DSN: string; SENTRY_DSN: string;
SITE_URL: string;
SMTP_HOST: string; SMTP_HOST: string;
SMTP_NAME: string; SMTP_NAME: string;
SMTP_PASSWORD: string; SMTP_PASSWORD: string;
@@ -31,7 +32,6 @@ declare global {
STRIPE_PUBLISHABLE_KEY: string; STRIPE_PUBLISHABLE_KEY: string;
STRIPE_SECRET_KEY: string; STRIPE_SECRET_KEY: string;
STRIPE_WEBHOOK_SECRET: string; STRIPE_WEBHOOK_SECRET: string;
WEBSITE_URL: string;
} }
} }
} }

8
backend/src/config/index.ts
View File

@@ -17,6 +17,7 @@ const POSTHOG_PROJECT_API_KEY = process.env.POSTHOG_PROJECT_API_KEY!;
const PRIVATE_KEY = process.env.PRIVATE_KEY!; const PRIVATE_KEY = process.env.PRIVATE_KEY!;
const PUBLIC_KEY = process.env.PUBLIC_KEY!; const PUBLIC_KEY = process.env.PUBLIC_KEY!;
const SENTRY_DSN = process.env.SENTRY_DSN!; const SENTRY_DSN = process.env.SENTRY_DSN!;
const SITE_URL = process.env.SITE_URL!;
const SMTP_HOST = process.env.SMTP_HOST! || 'smtp.gmail.com'; const SMTP_HOST = process.env.SMTP_HOST! || 'smtp.gmail.com';
const SMTP_NAME = process.env.SMTP_NAME!; const SMTP_NAME = process.env.SMTP_NAME!;
const SMTP_USERNAME = process.env.SMTP_USERNAME!; const SMTP_USERNAME = process.env.SMTP_USERNAME!;
@@ -27,7 +28,8 @@ const STRIPE_PRODUCT_STARTER = process.env.STRIPE_PRODUCT_STARTER!;
const STRIPE_PUBLISHABLE_KEY = process.env.STRIPE_PUBLISHABLE_KEY!; const STRIPE_PUBLISHABLE_KEY = process.env.STRIPE_PUBLISHABLE_KEY!;
const STRIPE_SECRET_KEY = process.env.STRIPE_SECRET_KEY!; const STRIPE_SECRET_KEY = process.env.STRIPE_SECRET_KEY!;
const STRIPE_WEBHOOK_SECRET = process.env.STRIPE_WEBHOOK_SECRET!; const STRIPE_WEBHOOK_SECRET = process.env.STRIPE_WEBHOOK_SECRET!;
const WEBSITE_URL = 'http://frontend:3000';
console.log('New SITE_URL: ', SITE_URL);
export { export {
PORT, PORT,
@@ -49,6 +51,7 @@ export {
PRIVATE_KEY, PRIVATE_KEY,
PUBLIC_KEY, PUBLIC_KEY,
SENTRY_DSN, SENTRY_DSN,
SITE_URL,
SMTP_HOST, SMTP_HOST,
SMTP_NAME, SMTP_NAME,
SMTP_USERNAME, SMTP_USERNAME,
@@ -58,6 +61,5 @@ export {
STRIPE_PRODUCT_STARTER, STRIPE_PRODUCT_STARTER,
STRIPE_PUBLISHABLE_KEY, STRIPE_PUBLISHABLE_KEY,
STRIPE_SECRET_KEY, STRIPE_SECRET_KEY,
STRIPE_WEBHOOK_SECRET, STRIPE_WEBHOOK_SECRET
WEBSITE_URL
}; };

5
backend/src/controllers/membershipController.ts
View File

@@ -6,7 +6,7 @@ import {
deleteMembership as deleteMember deleteMembership as deleteMember
} from '../helpers/membership'; } from '../helpers/membership';
import { sendMail } from '../helpers/nodemailer'; import { sendMail } from '../helpers/nodemailer';
import { WEBSITE_URL } from '../config'; import { SITE_URL } from '../config';
import { ADMIN, MEMBER, GRANTED, ACCEPTED } from '../variables'; import { ADMIN, MEMBER, GRANTED, ACCEPTED } from '../variables';
/** /**
@@ -217,11 +217,10 @@ export const inviteUserToWorkspace = async (req: Request, res: Response) => {
inviterFirstName: req.user.firstName, inviterFirstName: req.user.firstName,
inviterEmail: req.user.email, inviterEmail: req.user.email,
workspaceName: req.membership.workspace.name, workspaceName: req.membership.workspace.name,
callback_url: WEBSITE_URL + '/login' callback_url: SITE_URL + '/login'
} }
}); });
} catch (err) { } catch (err) {
console.error(err);
Sentry.setUser({ email: req.user.email }); Sentry.setUser({ email: req.user.email });
Sentry.captureException(err); Sentry.captureException(err);
return res.status(400).send({ return res.status(400).send({

4
backend/src/controllers/membershipOrgController.ts
View File

@@ -1,7 +1,7 @@
import { Request, Response } from 'express'; import { Request, Response } from 'express';
import * as Sentry from '@sentry/node'; import * as Sentry from '@sentry/node';
import crypto from 'crypto'; import crypto from 'crypto';
import { WEBSITE_URL, JWT_SIGNUP_LIFETIME, JWT_SIGNUP_SECRET } from '../config'; import { SITE_URL, JWT_SIGNUP_LIFETIME, JWT_SIGNUP_SECRET } from '../config';
import { MembershipOrg, Organization, User, Token } from '../models'; import { MembershipOrg, Organization, User, Token } from '../models';
import { deleteMembershipOrg as deleteMemberFromOrg } from '../helpers/membershipOrg'; import { deleteMembershipOrg as deleteMemberFromOrg } from '../helpers/membershipOrg';
import { checkEmailVerification } from '../helpers/signup'; import { checkEmailVerification } from '../helpers/signup';
@@ -186,7 +186,7 @@ export const inviteUserToOrganization = async (req: Request, res: Response) => {
organizationName: organization.name, organizationName: organization.name,
email: inviteeEmail, email: inviteeEmail,
token, token,
callback_url: WEBSITE_URL + '/signupinvite' callback_url: SITE_URL + '/signupinvite'
} }
}); });
} }

10
backend/src/controllers/organizationController.ts
View File

@@ -1,11 +1,11 @@
import { Request, Response } from 'express'; import { Request, Response } from 'express';
import * as Sentry from '@sentry/node'; import * as Sentry from '@sentry/node';
import { import {
SITE_URL,
STRIPE_SECRET_KEY, STRIPE_SECRET_KEY,
STRIPE_PRODUCT_STARTER, STRIPE_PRODUCT_STARTER,
STRIPE_PRODUCT_PRO, STRIPE_PRODUCT_PRO,
STRIPE_PRODUCT_CARD_AUTH, STRIPE_PRODUCT_CARD_AUTH
WEBSITE_URL
} from '../config'; } from '../config';
import Stripe from 'stripe'; import Stripe from 'stripe';
const stripe = new Stripe(STRIPE_SECRET_KEY, { const stripe = new Stripe(STRIPE_SECRET_KEY, {
@@ -350,13 +350,13 @@ export const createOrganizationPortalSession = async (
customer: req.membershipOrg.organization.customerId, customer: req.membershipOrg.organization.customerId,
mode: 'setup', mode: 'setup',
payment_method_types: ['card'], payment_method_types: ['card'],
success_url: WEBSITE_URL + '/dashboard', success_url: SITE_URL + '/dashboard',
cancel_url: WEBSITE_URL + '/dashboard' cancel_url: SITE_URL + '/dashboard'
}); });
} else { } else {
session = await stripe.billingPortal.sessions.create({ session = await stripe.billingPortal.sessions.create({
customer: req.membershipOrg.organization.customerId, customer: req.membershipOrg.organization.customerId,
return_url: WEBSITE_URL + '/dashboard' return_url: SITE_URL + '/dashboard'
}); });
} }

5
backend/src/index.ts
View File

@@ -6,7 +6,7 @@ import mongoose from 'mongoose';
import dotenv from 'dotenv'; import dotenv from 'dotenv';
dotenv.config(); dotenv.config();
import * as Sentry from '@sentry/node'; import * as Sentry from '@sentry/node';
import { PORT, SENTRY_DSN, NODE_ENV, MONGO_URL, WEBSITE_URL } from './config'; import { PORT, SENTRY_DSN, NODE_ENV, MONGO_URL, SITE_URL } from './config';
import { apiLimiter } from './helpers/rateLimiter'; import { apiLimiter } from './helpers/rateLimiter';
const app = express(); const app = express();
@@ -38,7 +38,6 @@ import {
} from './routes'; } from './routes';
const connectWithRetry = () => { const connectWithRetry = () => {
console.log('MONGO_URL', MONGO_URL);
mongoose.connect(MONGO_URL) mongoose.connect(MONGO_URL)
.then(() => console.log('Successfully connected to DB')) .then(() => console.log('Successfully connected to DB'))
.catch((e) => { .catch((e) => {
@@ -55,7 +54,7 @@ app.enable('trust proxy');
app.use(cookieParser()); app.use(cookieParser());
app.use(cors({ app.use(cors({
credentials: true, credentials: true,
origin: WEBSITE_URL origin: SITE_URL
})); }));
if (NODE_ENV === 'production') { if (NODE_ENV === 'production') {

10
docker-compose.dev.yml
View File

@@ -4,6 +4,7 @@ services:
nginx: nginx:
container_name: infisical-dev-nginx container_name: infisical-dev-nginx
image: nginx image: nginx
restart: always
ports: ports:
- 8080:80 - 8080:80
volumes: volumes:
@@ -47,6 +48,8 @@ services:
- ./frontend/styles:/app/styles - ./frontend/styles:/app/styles
- ./frontend/components:/app/components - ./frontend/components:/app/components
env_file: .env env_file: .env
environment:
- NEXT_PUBLIC_WEBSITE_URL=${SITE_URL}
networks: networks:
- infisical-dev - infisical-dev
@@ -55,6 +58,9 @@ services:
container_name: infisical-dev-mongo container_name: infisical-dev-mongo
restart: always restart: always
env_file: .env env_file: .env
environment:
- MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME}
- MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD}
volumes: volumes:
- mongo-data:/data/db - mongo-data:/data/db
networks: networks:
@@ -65,6 +71,10 @@ services:
image: mongo-express image: mongo-express
restart: always restart: always
env_file: .env env_file: .env
environment:
- ME_CONFIG_MONGODB_ADMINUSERNAME=${MONGO_USERNAME}
- ME_CONFIG_MONGODB_ADMINPASSWORD=${MONGO_PASSWORD}
- ME_CONFIG_MONGODB_URL=mongodb://${MONGO_USERNAME}:${MONGO_PASSWORD}@mongo:27017/
ports: ports:
- 8081:8081 - 8081:8081
networks: networks:

28
docker-compose.yml
View File

@@ -4,6 +4,7 @@ services:
nginx: nginx:
container_name: infisical-nginx container_name: infisical-nginx
image: nginx image: nginx
restart: always
ports: ports:
- 80:80 - 80:80
- 443:443 - 443:443
@@ -16,34 +17,28 @@ services:
- infisical - infisical
backend: backend:
platform: linux/amd64
container_name: infisical-backend container_name: infisical-backend
restart: unless-stopped restart: unless-stopped
depends_on: depends_on:
- mongo - mongo
build:
context: ./backend
dockerfile: Dockerfile
image: infisical/backend image: infisical/backend
volumes:
- ./backend/src:/app/src
- ./backend/nodemon.json:/app/nodemon.json
- /app/node_modules
command: npm run start command: npm run start
env_file: .env env_file: .env
networks: networks:
- infisical - infisical
frontend: frontend:
platform: linux/amd64
container_name: infisical-frontend container_name: infisical-frontend
restart: unless-stopped restart: unless-stopped
depends_on: depends_on:
- backend - backend
build:
context: ./frontend
dockerfile: Dockerfile.prod
image: infisical/frontend image: infisical/frontend
volumes:
- ./frontend/pages:/app/pages
- ./frontend/public:/app/public
- ./frontend/styles:/app/styles
- ./frontend/components:/app/components
- ./frontend/next.config.js:/app/next.config.js
env_file: .env env_file: .env
networks: networks:
- infisical - infisical
@@ -52,15 +47,14 @@ services:
container_name: infisical-mongo container_name: infisical-mongo
image: mongo image: mongo
restart: always restart: always
env_file: .env
environment:
- MONGO_INITDB_ROOT_USERNAME=${MONGO_USERNAME}
- MONGO_INITDB_ROOT_PASSWORD=${MONGO_PASSWORD}
volumes: volumes:
- mongo-data:/data/db - mongo-data:/data/db
networks: networks:
- infisical - infisical
watchtower:
image: containrrr/watchtower
volumes:
- /var/run/docker.sock:/var/run/docker.sock
volumes: volumes:
mongo-data: mongo-data:

50
docs/self-hosting/configuration/envars.mdx
View File

@@ -7,29 +7,27 @@ description: ""
Configuring Infisical requires setting some environment variables. There is a file called `.env.example` at the root directory of our main repo that you can use to create a `.env` before you start the server. Configuring Infisical requires setting some environment variables. There is a file called `.env.example` at the root directory of our main repo that you can use to create a `.env` before you start the server.
| Variable | Description | Default Value | | Variable | Description | Default Value |
| --------------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------- | | ---------------------------- | ----------------------------------------------------------------------------------------------------------- | ---------------- |
| `PRIVATE_KEY` | ❗️ NaCl-generated server secret key | `None` | | `PRIVATE_KEY` | ❗️ NaCl-generated server secret key | `None` |
| `PUBLIC_KEY` | ❗️ NaCl-generated server public key | `None` | | `PUBLIC_KEY` | ❗️ NaCl-generated server public key | `None` |
| `ENCRYPTION_KEY` | ❗️ Strong hex encryption key | `None` | | `ENCRYPTION_KEY` | ❗️ Strong hex encryption key | `None` |
| `JWT_SIGNUP_SECRET` | ❗️JWT token secret | `None` | | `JWT_SIGNUP_SECRET` | ❗️JWT token secret | `None` |
| `JWT_REFRESH_SECRET` | ❗️ JWT token secret | `None` | | `JWT_REFRESH_SECRET` | ❗️ JWT token secret | `None` |
| `JWT_AUTH_SECRET` | ❗️ JWT token secret | `None` | | `JWT_AUTH_SECRET` | ❗️ JWT token secret | `None` |
| `JWT_SIGNUP_LIFETIME` | JWT token lifetime expressed in seconds or a string describing a time span (e.g. 60, "2 days", "10h", "7d") | `15m` | | `JWT_SIGNUP_LIFETIME` | JWT token lifetime expressed in seconds or a string describing a time span (e.g. 60, "2 days", "10h", "7d") | `15m` |
| `JWT_REFRESH_LIFETIME` | JWT token lifetime expressed in seconds or a string describing a time span (e.g. 60, "2 days", "10h", "7d") | `90d` | | `JWT_REFRESH_LIFETIME` | JWT token lifetime expressed in seconds or a string describing a time span (e.g. 60, "2 days", "10h", "7d") | `90d` |
| `JWT_AUTH_LIFETIME` | JWT token lifetime expressed in seconds or a string describing a time span (e.g. 60, "2 days", "10h", "7d") | `10d` | | `JWT_AUTH_LIFETIME` | JWT token lifetime expressed in seconds or a string describing a time span (e.g. 60, "2 days", "10h", "7d") | `10d` |
| `EMAIL_TOKEN_LIFETIME` | Email OTP/magic-link lifetime expressed in seconds | `86400` | | `EMAIL_TOKEN_LIFETIME` | Email OTP/magic-link lifetime expressed in seconds | `86400` |
| `MONGO_URL` | ❗️ MongoDB instance connection string either to container instance or MongoDB Cloud | `None` | | `MONGO_URL` | ❗️ MongoDB instance connection string either to container instance or MongoDB Cloud | `None` |
| `MONGO_INITDB_ROOT_USERNAME` | MongoDB container username | `None` | | `MONGO_USERNAME` | MongoDB username if using container | `None` |
| `MONGO_INITDB_ROOT_PASSWORD` | MongoDB container password | `None` | | `MONGO_PASSWORD` | MongoDB password if using container | `None` |
| `ME_CONFIG_MONGODB_ADMINUSERNAME` | Same as `MONGO_USERNAME` for mongo-express in development | `None` | | `NODE_ENV` | ❗️ `production` or `development` | `None` |
| `ME_CONFIG_MONGODB_ADMINPASSWORD` | Same as `MONGO_PASSWORD` for mongo-express in development | `None` | | `SITE_URL` | ❗️ Site URL - should be an absolute URL including the protocol (e.g. `https://app.infisical.com`) | `None` |
| `NODE_ENV` | ❗️ `production` or `development` | `None` | | `SMT_HOST` | Whether the user joined the community | `smtp.gmail.com` |
| `NEXT_PUBLIC_WEBSITE_URL` | ❗️ Site URL - should be an absolute URL including the protocol (e.g. `https://infisical.com`) | `None` | | `SMTP_NAME` | ❗️ Whether the user joined the community | `None` |
| `SMT_HOST` | Whether the user joined the community | `smtp.gmail.com` | | `SMTP_USERNAME` | ❗️ Whether the user joined the community | `None` |
| `SMTP_NAME` | ❗️ Whether the user joined the community | `None` | | `SMTP_PASSWORD` | ❗️ Whether the user joined the community | `None` |
| `SMTP_USERNAME` | ❗️ Whether the user joined the community | `None` | | `OAUTH_CLIENT_SECRET_HEROKU` | OAuth client secret for Heroku integration | `None` |
| `SMTP_PASSWORD` | ❗️ Whether the user joined the community | `None` | | `OAUTH_TOKEN_URL_HEROKU` | OAuth token URL for Heroku integration | `None` |
| `OAUTH_CLIENT_SECRET_HEROKU` | OAuth client secret for Heroku integration | `None` | | `SENTRY_DSN` | DSN for error-monitoring with Sentry | `None` |
| `OAUTH_TOKEN_URL_HEROKU` | OAuth token URL for Heroku integration | `None` |
| `SENTRY_DSN` | DSN for error-monitoring with Sentry | `None` |

5
frontend/Dockerfile.dev
View File

@@ -7,10 +7,9 @@ WORKDIR /app
# Copy over dependency files # Copy over dependency files
COPY package.json ./ COPY package.json ./
COPY package-lock.json ./ COPY package-lock.json ./
COPY yarn.lock ./
# Install # Install
RUN yarn install RUN npm install
# Copy over next.js config # Copy over next.js config
COPY next.config.js ./next.config.js COPY next.config.js ./next.config.js
@@ -18,4 +17,4 @@ COPY next.config.js ./next.config.js
# Copy all files # Copy all files
COPY . . COPY . .
CMD ["yarn", "dev"] CMD ["npm", "run", "dev"]

1
frontend/Dockerfile.prod
View File

@@ -7,7 +7,6 @@ WORKDIR /app
# Copy over dependency files # Copy over dependency files
COPY package.json ./ COPY package.json ./
COPY package-lock.json ./ COPY package-lock.json ./
COPY yarn.lock ./
# Install # Install
RUN npm install RUN npm install