steedos-configuration

Configure Steedos server environment variables and YAML settings for deployment.

1.6k|414|Updated Mar 4, 2019
One-click install
npx skills add https://github.com/steedos/steedos-platform --skill steedos-configuration
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: steedos-configuration
Source: https://github.com/steedos/steedos-platform/tree/main/skills/steedos-configuration
Command: npx skills add https://github.com/steedos/steedos-platform --skill steedos-configuration

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Setting up a Steedos server requires knowing dozens of environment variables and YAML configuration sections, and misconfiguration of MongoDB, Redis, file storage, or SSO causes startup failures that are hard to diagnose.

Core Features & Use Cases

  • Environment Variable Reference: Documents required and optional variables such as MONGO_URL, ROOT_URL, B6_TRANSPORTER, JWT_SECRET, storage, plugin, and localization settings.
  • YAML Configuration Templates: Provides ready-to-adapt sections for datasources, tenant settings, CFS file storage (local, AWS S3, Aliyun), email, SSO/OIDC, and cron jobs with ${ENV_VAR} interpolation.
  • Deployment Examples: Includes complete development and production .env files plus a Docker Compose setup with MongoDB and Redis.
  • Use Case: When deploying Steedos to production, copy the production .env template, set strong JWT secrets and S3 storage credentials, and verify connections using the troubleshooting table.

Quick Start

Ask the AI to generate a production-ready .env file and steedos-config.yml for a Steedos server using MongoDB, Redis, and AWS S3 storage.

Frequently Asked Questions about steedos-configuration

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I configure environment variables for a Steedos server?

Create a .env file in the project root with MONGO_URL, ROOT_URL, TRANSPORTER, and CACHER at minimum. System environment variables take highest priority, followed by .env.local, then .env.

What environment variables are required to start Steedos?

Steedos requires MONGO_URL for the MongoDB connection, ROOT_URL for the application URL, and TRANSPORTER plus CACHER pointing to Redis for the Moleculer service mesh. JWT_SECRET is strongly recommended for signing tokens.

How do I configure file storage in Steedos with AWS S3?

Set the cfs.store YAML value to aws and provide region, endpoint, bucket, accessKeyId, and secretAccessKey via STEEDOS_CFS_AWS_* environment variables. Supported backends are local, aliyun, aws, and steedosCloud.

Can I use environment variables inside Steedos YAML configuration?

Yes, Steedos YAML files support ${ENV_VAR} interpolation, so values like datasource URLs, tenant secrets, and OIDC client credentials can be injected from environment variables at runtime.

Why are my Steedos environment variables not loading?

Verify the file is named exactly .env and located in the project root, not named env.txt, then restart the server. Also check that system-level variables are not unintentionally overriding file values due to priority order.

How do I set up SSO/OIDC login in Steedos?

Add an sso.oidc section to the YAML config with config_url, client_id, client_secret, name, and label, each referencing STEEDOS_IDENTITY_OIDC_* environment variables from your identity provider.