Brevia Admin

Brevia API Admin webapp built with Nuxt 3.

Setup

Make sure to install the dependencies (using npm):

# npm
npm install

Environment variables

On a development environment you can use a .env file in the root of the project simply by copying the .env.sample file. This file can however be used as a reference for usable environment variables.

The only required variables for Brevia App are: NUXT_API_BASE_URL and NUXT_BREVIA_SESSION_SECRET. See below for more details. With these env vars you can run a minimal version with default access credentials.

Brevia API

• NUXT_API_BASE_URL Brevia API base URL
• NUXT_API_SECRET Brevia API secret, use it if an access token is required by the API

Session

Configure the session settings with the following variables:

## SESSION
NUXT_BREVIA_SESSION_NAME=Brevia
NUXT_BREVIA_SESSION_SECRET=example-32-characters-long-secret-key

• NUXT_BREVIA_SESSION_NAME (optional, default: Brevia) - The name of the session cookie.
• NUXT_BREVIA_SESSION_SECRET - A secret used to encrypt/decrypt the session cookie. It must be at least 32 chars.

Authentication

Brevia, by design, does not have a real authentication and authorization system. Instead, it has a minimal access control with username and password and two possible roles (admin and user) that can be defined through a simple NUXT_BREVIA_AUTH_CREDENTIALS environment variable.

If you want to use a real authentication and authorization system, it is advisable to use an integration with a CMS, a document system or other types of software that already manage these topics much better than Brevia could. An integration with the BEdita CMS is available as a reference.

Usage example:

NUXT_BREVIA_AUTH_CREDENTIALS='[{"username":"tizio","password":"incognito","name":"Tizio Incognito", "roles": ["user"]}]'

If NUXT_BREVIA_AUTH_CREDENTIALS is not set, you can log in using the default credentials:

• Username: brevia
• Password: brevia

Multi-project setup

Through NUXT_PROJECTS env var you can enable multi-project setup.

You can define multiple projects with different API base URLs and secrets using a JSON object.Every project must have a unique name.

NUXT_PROJECTS='{
  "Project 1": {
    "apiBaseUrl": "https://project1-api.example.com",
    "apiSecret": "#####"
  },
  "Project 2": {
    "apiBaseUrl": "https://project2-api.example.com",
    "apiSecret": "#####"
  }
}'

If NUXT_PROJECTS is set the default NUXT_API_BASE_URL and NUXT_API_SECRET vars are ignored and as default the login page will show a dropdown to select the project to log in to.

You may also set the NUXT_PUBLIC_PROJECT_LOGIN env var to true to enable the /project-login/{project} page.

If enabled login is available only on /project-login/{project} where {project} must match a project unique name in NUXT_PROJECTS - match is performed with lowercase versions and with hyphens ('-') instead of spaces.

If enabled, using the above NUXT_PROJECTS example:

• /project-login/project-1 will use "Project 1" configuration
• /project-login/project-2 will use "Project 2" configuration
• /project-login/project-3 will raise a 404 error page

BEdita Integration

To activate BEdita integration, configure the following variables:

## BEDITA INTEGRATION
NUXT_PUBLIC_INTEGRATION=bedita
NUXT_BEDITA_API_BASE_URL=<BEDITA API BASE URL>
NUXT_BEDITA_API_KEY=<BEDITA API KEY>
NUXT_BEDITA_SESSION_NAME=bedita
NUXT_BEDITA_SESSION_SECRET=<BEDITA SESSION SECRET>

• NUXT_PUBLIC_INTEGRATION - Integration type, set to bedita to enable BEdita integration.
• NUXT_BEDITA_API_BASE_URL - BEdita API base URL.
• NUXT_BEDITA_API_KEY - BEdita API key.
• NUXT_BEDITA_SESSION_NAME (optional, default is bedita) - The name used for the session cookie.
• NUXT_BEDITA_SESSION_SECRET - The secret used to encrypt/decrypt the session stored in the cookie. It must be at least 32 chars.

When building the application in production mode (see Production), make sure that the environment variable NUXT_PUBLIC_INTEGRATION is set to bedita to enable the BEdita integration. If no .env file is present, you may want to use a command like this:

NUXT_PUBLIC_INTEGRATION=bedita npm run build

Recaptcha

To enable/disable Recaptcha you should edit these vars:

• NUXT_PUBLIC_RECAPTCHA_ENABLED (optional, default is false) Enable or disable Recaptcha
• NUXT_PUBLIC_RECAPTCHA_SITE_KEY (required if Recaptcha is enabled) Recaptcha site key
• NUXT_BEDITA_RECAPTCHA_SECRET_KEY (required if Recaptcha is enabled) Recaptcha secret key

### Multi-project BEdita setup

By editing NUXT_BEDITA_PROJECTS you can enable multi-project setup using BEdita integration. Just like in NUXT_PROJECTS you can define multiple projects with different API base URLs and secrets using a JSON object.

Every project must have the same unique name as in NUXT_PROJECTS and every BEdita API instance must have the brevia-bedita plugin installed and configured to use the same NUXT_API_BASE_URL used in the corresponding NUXT_PROJECTS configuration

Here NUXT_BEDITA_PROJECTS configuration sample for the NUXT_PROJECTS configuration example above:

NUXT_BEDITA_PROJECTS='{
  "Project 1": {
    "apiBaseUrl": "https://project1-bedita-api.example.com",
    "apiKey": "#####"
  },
  "Project 2": {
    "apiBaseUrl": "https://project2-bedita-api.example.com",
    "apiKey": "#####"
  }
}'

Development Server

Start the development server on http://localhost:3000

npm run dev

Production

Build the application for production:

npm run build

To start the application:

npm start

Locally preview production build:

npm run preview

Check out the deployment documentation for more information.