Intake24

Appearance

Application ​

Path: apps/api/src/config/app.ts

Node environment ​

Node environment to start the application in.

  • object-path: env
  • dotenv var: NODE_ENV
  • type: 'development' | 'test' | 'production'
  • default: 'development'

Name ​

Application name.

  • object-path: env
  • dotenv var: APP_NAME
  • type: string
  • default: 'Intake24'

Icon 🍴 ​

Application icon - unicode character.

  • object-path: env
  • dotenv var: APP_ICON
  • type: string | undefined
  • default: undefined

Powered by ​

Powered by text (e.g. local team running the instance).

  • object-path: env
  • dotenv var: APP_POWERED_BY
  • type: string | undefined
  • default: undefined

Host ​

Internal hostname application listens on.

  • object-path: host
  • dotenv var: APP_HOST
  • type: string
  • default: 'localhost'

Port ​

Internal port application listens on.

  • object-path: port
  • dotenv var: APP_PORT
  • type: number
  • default: 3100

Secret ​

Secret key to use for in-app signing/encryption (cookie/session)

(You need to replace the default value, e.g. verybigappsecret)

  • object-path: secret
  • dotenv var: APP_SECRET
  • type: string
  • default: ''

HTTPS ​

Flag whether to use HTTPS protocol, for development purposes. Defaults to false.

Certificates are generated by mkcert & vite-plugin-mkcert.

  • firstly boot up any frontend application in dev mode, which will generate certificates on first run
  • then boot up API server in dev mode
  • certificates are stored in user home directory by default, i.e. ~/vite-plugin-mkcert

For production, it is recommended to use http protocol and reverse proxy (e.g. nginx) to handle HTTPS.

  • object-path: https
  • dotenv var: DEV_HTTPS
  • type: boolean
  • default: false

HTTPS certificates path ​

Path to local certificates folder

Certificates are generated by mkcert & vite-plugin-mkcert.

  • certificates are stored in user home directory by default, i.e.

  • object-path: certPath

  • dotenv var: DEV_MKCERT_PATH

  • type: string

  • default: undefined (resolves to default: ~/vite-plugin-mkcert)

Sites URLs ​

List of sites URLs. These can either be relative or absolute URLs.

  • absolute URL -> site is hosted on different domain
  • relative URL -> site is hosted on same domain. URL gets registered as route.

Base URL / Domain ​

Domain / base url to resolve fully qualified sites URLs (if relative)

  • object-path: urls.base
  • dotenv var: APP_URL_BASE
  • type: string
  • default: 'localhost:3100'

Admin URL ​

URL of admin site.

  • object-path: urls.admin
  • dotenv var: APP_URL_ADMIN
  • type: string
  • default: '/admin'

Documentation URL ​

URL of documentation site.

  • object-path: urls.docs
  • dotenv var: APP_URL_DOCS
  • type: string
  • default: '/docs'

Survey URL ​

URL of survey site.

  • object-path: urls.survey
  • dotenv var: APP_URL_SURVEY
  • type: string
  • default: '/survey'

Images URL ​

URL of images.

  • object-path: urls.images
  • dotenv var: APP_URL_IMAGES
  • type: string
  • default: 'localhost:3100/images'

TIP

Default setup allows local images serving - ideal for development purposes. For production, use reverse proxy, CDN etc.

Media URL ​

URL of media files.

  • object-path: urls.media
  • dotenv var: APP_URL_MEDIA
  • type: string
  • default: 'localhost:3100/media'

TIP

Default setup allows local media serving - ideal for development purposes. For production, use reverse proxy, CDN etc.