Installation & Setup
Installation
Install Jodit Connector Node.js via npm:
npm install jodit-nodejs
Environment Variables
You can configure the application using environment variables with npm or Docker:
Using npm
# Basic setup - configure default source
SOURCE_NAME="My Files" \
SOURCE_ROOT="/var/www/uploads" \
SOURCE_BASEURL="http://localhost:8081/uploads/" \
npm start
# Production setup with custom port
SOURCE_NAME="Production Files" \
SOURCE_ROOT="/var/www/uploads" \
SOURCE_BASEURL="https://cdn.example.com/uploads/" \
PORT=8080 \
npm start
# Using full JSON configuration
CONFIG='{"debug":false,"allowCrossOrigin":true,"sources":{"production":{"name":"production","title":"Production Files","root":"/var/www/uploads","baseurl":"https://cdn.example.com/uploads/"}}}' \
PORT=8080 \
npm start
# Using config file
CONFIG_FILE="/etc/jodit/config.json" \
PORT=8080 \
npm start
Using Docker
# Basic setup with environment variables
docker run --rm -p 8081:8081 \
-e SOURCE_NAME="My Files" \
-e SOURCE_ROOT="/usr/src/app/files" \
-e SOURCE_BASEURL="http://localhost:8081/files/" \
-v $(pwd)/files:/usr/src/app/files \
chupurnov/jodit-nodejs
# Production setup with custom port
docker run --rm -p 8080:8080 \
-e PORT=8080 \
-e SOURCE_NAME="Production Files" \
-e SOURCE_ROOT="/usr/src/app/files" \
-e SOURCE_BASEURL="https://cdn.example.com/uploads/" \
-v /var/www/uploads:/usr/src/app/files \
chupurnov/jodit-nodejs
# Using JSON configuration
docker run --rm -p 8080:8080 \
-e PORT=8080 \
-e CONFIG='{"debug":false,"allowCrossOrigin":true,"sources":{"production":{"name":"production","title":"Production","root":"/usr/src/app/files","baseurl":"https://cdn.example.com/uploads/"}}}' \
-v /var/www/uploads:/usr/src/app/files \
chupurnov/jodit-nodejs
# Using config file (recommended for complex configurations)
docker run --rm -p 8081:8081 \
-v $(pwd)/config.json:/usr/src/app/config.json \
-v $(pwd)/files:/usr/src/app/files \
chupurnov/jodit-nodejs
Available Environment Variables
SOURCE_NAME
- Display name for the default source (default: "Test Files")SOURCE_ROOT
- Absolute path to the files directory (default: "./files/test")SOURCE_BASEURL
- Base URL for accessing files (default: "http://localhost:8081/files/test/")PORT
- Server port (default: 8081)CONFIG
- Full configuration as JSON string (highest priority, overrides CONFIG_FILE and default config)CONFIG_FILE
- Path to JSON configuration file (overrides default config)
Configuration Priority
CONFIG
environment variable (highest priority)CONFIG_FILE
environment variable- Default configuration from code
Running the Application
Development Mode
npm run dev # Run with nodemon (hot reload)
Production Mode
npm run build # Compile TypeScript
npm start # Run compiled application
Using Docker
# Build and run
docker build -t jodit-nodejs .
docker run --rm -p 8081:8081 jodit-nodejs
# With custom config
docker run --rm -p 8081:8081 \
-v /host/path/to/config.json:/usr/src/app/config.json \
-v /host/path/to/files:/usr/src/app/files \
jodit-nodejs
For detailed Docker instructions, see Docker Deployment.
Next Steps
- API Usage - Learn how to use the API in your code
- Express Integration - Integrate with existing Express apps
- Configuration Reference - Explore all configuration options
- Authentication - Set up authentication methods
- Access Control - Configure permissions and ACL rules