mirror of
https://github.com/documenso/documenso.git
synced 2026-07-02 01:01:00 +10:00
Compare commits
4 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
| 652951ed7f | |||
| 40db5baa17 | |||
| 4cdfa2d1f0 | |||
| ba82b1fca8 |
+29
@@ -0,0 +1,29 @@
|
||||
DATABASE_URL="postgres://documenso:password@127.0.0.1:54320/documenso"
|
||||
NEXT_PUBLIC_WEBAPP_URL=""
|
||||
|
||||
# AUTH
|
||||
NEXTAUTH_SECRET='lorem ipsum sit dolor random string for encryption this could literally be anything'
|
||||
NEXTAUTH_URL=""
|
||||
|
||||
# SIGNING
|
||||
CERT_FILE_PATH=""
|
||||
CERT_PASSPHRASE=""
|
||||
CERT_FILE_ENCODING=""
|
||||
|
||||
# EMAIL
|
||||
SMTP_MAIL_HOST='127.0.0.1'
|
||||
SMTP_MAIL_PORT='2500'
|
||||
SMTP_MAIL_USER='documenso'
|
||||
SMTP_MAIL_PASSWORD='documenso'
|
||||
MAIL_FROM='documenso@gitpod.io'
|
||||
|
||||
# STRIPE
|
||||
STRIPE_API_KEY=""
|
||||
STRIPE_WEBHOOK_SECRET=""
|
||||
NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_MONTHLY_PRICE_ID=""
|
||||
NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_YEARLY_PRICE_ID=""
|
||||
|
||||
#FEATURE FLAGS
|
||||
# Allow users to register via the /signup page. Otherwise they will be redirect to the home page.
|
||||
NEXT_PUBLIC_ALLOW_SIGNUP=true
|
||||
NEXT_PUBLIC_ALLOW_SUBSCRIPTIONS=false
|
||||
+60
@@ -0,0 +1,60 @@
|
||||
tasks:
|
||||
- name: Dependencies & Database
|
||||
init: |
|
||||
npm install &&
|
||||
npm run docker:compose-up &&
|
||||
cp .env.gitpod .env &&
|
||||
next_auth_secret=$(openssl rand -base64 32) &&
|
||||
sed -i -e "s|^NEXTAUTH_SECRET=.*|NEXTAUTH_SECRET=$next_auth_secret|" .env &&
|
||||
sed -i "s|NEXTAUTH_URL=\"\"|NEXTAUTH_URL=https://3000-${HOSTNAME}.${GITPOD_WORKSPACE_CLUSTER_HOST}|" .env &&
|
||||
sed -i "s|NEXT_PUBLIC_WEBAPP_URL=\"\"|NEXT_PUBLIC_WEBAPP_URL=https://3000-${HOSTNAME}.${GITPOD_WORKSPACE_CLUSTER_HOST}|" .env
|
||||
command: npm run d
|
||||
|
||||
- name: Database Studio
|
||||
command: |
|
||||
gp ports await 3000
|
||||
npm run db-studio
|
||||
|
||||
ports:
|
||||
- name: App
|
||||
port: 3000
|
||||
visibility: public
|
||||
onOpen: open-browser
|
||||
|
||||
- name: Mailbox
|
||||
port: 9000
|
||||
visibility: public
|
||||
onOpen: open-browser
|
||||
|
||||
- name: Database
|
||||
port: 54320
|
||||
visibility: private
|
||||
onOpen: ignore
|
||||
|
||||
- name: Mailserver
|
||||
port: 2500
|
||||
visibility: private
|
||||
onOpen: ignore
|
||||
|
||||
- name: Database Studio
|
||||
port: 5555
|
||||
visibility: public
|
||||
|
||||
- port: 1100
|
||||
visibility: private
|
||||
onOpen: ignore
|
||||
|
||||
github:
|
||||
prebuilds:
|
||||
master: true
|
||||
pullRequests: true
|
||||
pullRequestsFromForks: true
|
||||
addCheck: true
|
||||
addComment: true
|
||||
addBadge: true
|
||||
|
||||
vscode:
|
||||
extensions:
|
||||
- esbenp.prettier-vscode
|
||||
- bradlc.vscode-tailwindcss
|
||||
- Prisma.prisma
|
||||
@@ -135,6 +135,8 @@ Your database will also be available on port `54320`. You can connect to it usin
|
||||
|
||||
## Developer Setup
|
||||
|
||||
### Manual Setup
|
||||
|
||||
Follow these steps to setup documenso on you local machine:
|
||||
|
||||
- [Clone the repository](https://help.github.com/articles/cloning-a-repository/) it to your local device.
|
||||
@@ -165,6 +167,12 @@ Follow these steps to setup documenso on you local machine:
|
||||
- A demo certificate is provided in `/app/web/resources/certificate.p12`
|
||||
- To generate your own using these steps and a Linux Terminal or Windows Subsystem for Linux (WSL) see **[Create your own signing certificate](#creating-your-own-signing-certificate)**.
|
||||
|
||||
### Run in Gitpod
|
||||
|
||||
- Click below to launch a ready-to-use Gitpod workspace in your browser.
|
||||
|
||||
[](https://gitpod.io/#https://github.com/documenso/documenso)
|
||||
|
||||
## Updating
|
||||
|
||||
- If you pull the newest version from main, using `git pull`, it may be necessary to regenerate your database client
|
||||
@@ -212,10 +220,6 @@ We support a variety of deployment methods, and are actively working on adding m
|
||||
|
||||
[](https://railway.app/template/DjrRRX)
|
||||
|
||||
## Render
|
||||
|
||||
[](https://render.com/deploy?repo=https://github.com/documenso/documenso)
|
||||
|
||||
# Troubleshooting
|
||||
|
||||
## I'm not receiving any emails when using the developer quickstart
|
||||
|
||||
@@ -5,7 +5,7 @@
|
||||
"scripts": {
|
||||
"dev": "next dev",
|
||||
"build": "next build",
|
||||
"start": "next start -p $PORT",
|
||||
"start": "next start",
|
||||
"lint": "next lint",
|
||||
"db-studio": "prisma db studio",
|
||||
"stripe:listen": "stripe listen --forward-to localhost:3000/api/stripe/webhook"
|
||||
|
||||
@@ -1,7 +1,14 @@
|
||||
ARG NEXT_PUBLIC_WEBAPP_URL=http://localhost:3000
|
||||
ARG NEXT_PUBLIC_ALLOW_SIGNUP=true
|
||||
ARG NEXT_PUBLIC_ALLOW_SUBSCRIPTIONS=false
|
||||
ARG NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_MONTHLY_PRICE_ID
|
||||
ARG NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_YEARLY_PRICE_ID
|
||||
|
||||
FROM node:18-alpine AS base
|
||||
|
||||
# Install dependencies only when needed
|
||||
FROM base AS production_deps
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
|
||||
@@ -14,6 +21,13 @@ RUN npm ci --production
|
||||
|
||||
# Install dependencies only when needed
|
||||
FROM base AS builder
|
||||
|
||||
ARG NEXT_PUBLIC_WEBAPP_URL
|
||||
ARG NEXT_PUBLIC_ALLOW_SIGNUP
|
||||
ARG NEXT_PUBLIC_ALLOW_SUBSCRIPTIONS
|
||||
ARG NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_MONTHLY_PRICE_ID
|
||||
ARG NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_YEARLY_PRICE_ID
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
# Check https://github.com/nodejs/docker-node/tree/b4117f9333da4138b03a546ec926ef50a31506c3#nodealpine to understand why libc6-compat might be needed.
|
||||
@@ -28,6 +42,7 @@ RUN npm run build --workspaces
|
||||
|
||||
# Production image, copy all the files and run next
|
||||
FROM base AS runner
|
||||
|
||||
WORKDIR /app
|
||||
|
||||
ENV NODE_ENV production
|
||||
|
||||
-63
@@ -1,63 +0,0 @@
|
||||
services:
|
||||
- type: web
|
||||
name: documenso-app
|
||||
env: node
|
||||
plan: free
|
||||
buildCommand: npm i turbo && npm install --package-lock-only && npm ci && npm run build
|
||||
startCommand: npx prisma migrate deploy; npm run start
|
||||
healthCheckPath: /api/health
|
||||
|
||||
envVars:
|
||||
- key: NODE_VERSION
|
||||
value: 18.17.0
|
||||
|
||||
- key: DATABASE_URL
|
||||
fromDatabase:
|
||||
name: documenso-db
|
||||
property: connectionString
|
||||
|
||||
- key: NEXT_PUBLIC_WEBAPP_URL
|
||||
fromService:
|
||||
name: documenso-app
|
||||
type: web
|
||||
envVarKey: RENDER_EXTERNAL_URL
|
||||
|
||||
- key: NEXTAUTH_SECRET
|
||||
generateValue: true
|
||||
|
||||
- key: NEXTAUTH_URL
|
||||
fromService:
|
||||
name: documenso-app
|
||||
type: web
|
||||
envVarKey: RENDER_EXTERNAL_URL
|
||||
|
||||
- key: SENDGRID_API_KEY
|
||||
sync: false
|
||||
- key: SMTP_MAIL_HOST
|
||||
sync: false
|
||||
- key: SMTP_MAIL_PORT
|
||||
sync: false
|
||||
- key: SMTP_MAIL_USER
|
||||
sync: false
|
||||
- key: SMTP_MAIL_PASSWORD
|
||||
sync: false
|
||||
- key: MAIL_FROM
|
||||
sync: false
|
||||
|
||||
- key: NEXT_PUBLIC_ALLOW_SUBSCRIPTIONS
|
||||
value: false
|
||||
- key: STRIPE_API_KEY
|
||||
sync: false
|
||||
- key: STRIPE_WEBHOOK_SECRET
|
||||
sync: false
|
||||
- key: NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_MONTHLY_PRICE_ID
|
||||
sync: false
|
||||
- key: NEXT_PUBLIC_STRIPE_COMMUNITY_PLAN_YEARLY_PRICE_ID
|
||||
sync: false
|
||||
|
||||
- key: NEXT_PUBLIC_ALLOW_SIGNUP
|
||||
value: true
|
||||
|
||||
databases:
|
||||
- name: documenso-db
|
||||
plan: free
|
||||
Reference in New Issue
Block a user