[PR #86] [MERGED] Improved `start` CLI script #74

New issue

Closed

opened 2026-05-23 08:40:04 -06:00 by gitea-mirror · 0 comments

gitea-mirror commented

2026-05-23 08:40:04 -06:00

Owner

📋 Pull Request Information

Original PR: https://github.com/appy-one/acebase-server/pull/86
Author: @appy-one
Created: 5/22/2023
Status: ✅ Merged
Merged: 5/22/2023
Merged by: @appy-one

Base: master ← Head: improvement/more-cli-start-script-options

📝 Commits (1)

d44ba78 Improved start script (now available from CLI)

📊 Changes

1 file changed (+75 additions, -9 deletions)

View changed files

📝 src/start.ts (+75 -9)

📄 Description

This adds more configuration options to the start script, which is now available from the CLI with npx acebase-server start DBNAME=mydb HOST=localhost PORT=3000

Documentation:

Use environment variables or pass arguments to this script to start an AceBase server
instance from the command-line.

Command-line arguments format:
`npx acebase-server start DBNAME=mydb HOST=localhost PORT=3000`
You can use all variables mentioned below (without 'ACEBASE_' prefix)

All environment variables MUST be prefixed with 'ACEBASE_' (except for PORT if ACEBASE_PORT is not specified).
Currently available environment variables:

# File and network settings:
ACEBASE_DBNAME='mydb'
ACEBASE_DBPATH='.'
ACEBASE_HOST='localhost'
ACEBASE_PORT='3000'
ACEBASE_ROOT_PATH=''

# Transaction logging settings:
ACEBASE_TXLOG='true'
ACEBASE_TXDAYS='30'

# Auth settings:
ACEBASE_AUTH='true'
ACEBASE_AUTH_USER_SIGNUP='true'
ACEBASE_AUTH_DEFAULT_ACCESS_RULE='deny'
ACEBASE_AUTH_DEFAULT_ADMIN_PASSWORD=''
ACEBASE_AUTH_NEW_USER_RATE_LIMIT='0'
ACEBASE_AUTH_SEPARATE_DB='false'
ACEBASE_AUTH_TOKENS_EXPIRE='0'

# IPC configuration for single machine clusters
ACEBASE_IPC='socket'

# IPC configuration for multiple machine clusters (Make sure there is ONLY ONE 'master' instance)
ACEBASE_IPC_PORT='9163'
ACEBASE_IPC_HOST='ipc.example.com'
ACEBASE_IPC_ROLE='master'
ACEBASE_IPC_SSL='true'
ACEBASE_IPC_TOKEN='secret'

_{🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.}

## 📋 Pull Request Information **Original PR:** https://github.com/appy-one/acebase-server/pull/86 **Author:** [@appy-one](https://github.com/appy-one) **Created:** 5/22/2023 **Status:** ✅ Merged **Merged:** 5/22/2023 **Merged by:** [@appy-one](https://github.com/appy-one) **Base:** `master` ← **Head:** `improvement/more-cli-start-script-options` --- ### 📝 Commits (1) - [`d44ba78`](https://github.com/appy-one/acebase-server/commit/d44ba780894a8088e076184ad3a68b2f471d3421) Improved start script (now available from CLI) ### 📊 Changes **1 file changed** (+75 additions, -9 deletions) <details> <summary>View changed files</summary> 📝 `src/start.ts` (+75 -9) </details> ### 📄 Description This adds more configuration options to the start script, which is now available from the CLI with `npx acebase-server start DBNAME=mydb HOST=localhost PORT=3000` Documentation: ``` Use environment variables or pass arguments to this script to start an AceBase server instance from the command-line. Command-line arguments format: `npx acebase-server start DBNAME=mydb HOST=localhost PORT=3000` You can use all variables mentioned below (without 'ACEBASE_' prefix) All environment variables MUST be prefixed with 'ACEBASE_' (except for PORT if ACEBASE_PORT is not specified). Currently available environment variables: # File and network settings: ACEBASE_DBNAME='mydb' ACEBASE_DBPATH='.' ACEBASE_HOST='localhost' ACEBASE_PORT='3000' ACEBASE_ROOT_PATH='' # Transaction logging settings: ACEBASE_TXLOG='true' ACEBASE_TXDAYS='30' # Auth settings: ACEBASE_AUTH='true' ACEBASE_AUTH_USER_SIGNUP='true' ACEBASE_AUTH_DEFAULT_ACCESS_RULE='deny' ACEBASE_AUTH_DEFAULT_ADMIN_PASSWORD='' ACEBASE_AUTH_NEW_USER_RATE_LIMIT='0' ACEBASE_AUTH_SEPARATE_DB='false' ACEBASE_AUTH_TOKENS_EXPIRE='0' # IPC configuration for single machine clusters ACEBASE_IPC='socket' # IPC configuration for multiple machine clusters (Make sure there is ONLY ONE 'master' instance) ACEBASE_IPC_PORT='9163' ACEBASE_IPC_HOST='ipc.example.com' ACEBASE_IPC_ROLE='master' ACEBASE_IPC_SSL='true' ACEBASE_IPC_TOKEN='secret' ``` --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>