Skip to content

cmd service

github-actions[bot] edited this page Aug 25, 2026 · 4 revisions

nself service

Enable, disable, and list optional ɳSelf services.

Synopsis

nself service <subcommand> [flags]

Description

nself service manages the optional services in your ɳSelf stack. The four core services (PostgreSQL, Hasura, Auth, Nginx) are always included. The six optional services, Redis, MinIO, Email, Functions, Search, and Admin, are controlled through this command.

Enabling or disabling a service writes to your .env file. After changing service state, run nself build to regenerate docker-compose.yml with the updated service set, then nself restart to apply the changes.

MLflow is no longer an optional service. Use nself plugin install mlflow instead.

Available Services (6)

Service Env Var Aliases
redis REDIS_ENABLED
minio MINIO_ENABLED storage
email MAILPIT_ENABLED mail, mailpit
functions FUNCTIONS_ENABLED
search SEARCH_ENABLED meilisearch
monitoring MONITORING_ENABLED
admin NSELF_ADMIN_ENABLED

Flags

Flag Default Description
--env "" Target environment (reads .env.{env})
--help, -h Show help

Subcommands

Name Description
add Scaffold a custom service (CS_N slot) into the current project
configure Configure service settings (e.g. email provider presets)
disable Disable an optional service
enable Enable an optional service
list List all optional services with enabled/disabled status
ps Show status of all ɳSelf stack services
restart Restart a named ɳSelf service
scale Set the replica count for a named service
start Start a named ɳSelf service
stop Stop a named ɳSelf service (container preserved)
update Pull the latest image for a service and restart it
upgrade Pin a service to a specific image version

Examples

# List all optional services
nself service list
nself service list --json

# Enable Redis
nself service enable redis

# Enable MinIO object storage (using alias)
nself service enable storage

# Enable monitoring stack
nself service enable monitoring

# Enable monitoring for production environment
nself service enable monitoring --env prod

# Disable Mailpit
nself service disable mailpit

# Disable MeiliSearch (using alias)
nself service disable meilisearch

# After changing services, rebuild and restart
nself build && nself restart

See Also

Commands | Home

Home


Getting Started


Commands


Features


Configuration


Plugins (87 + 10 monitoring)

Free (25)
Pro (62)
Planned (26)
  • plugin-audit
  • plugin-blog
  • plugin-checkout
  • plugin-commerce
  • plugin-drm
  • plugin-export
  • plugin-flow
  • plugin-import
  • plugin-ldap
  • plugin-mailgun
  • plugin-media
  • plugin-oauth-providers
  • plugin-pages
  • plugin-postmark
  • plugin-rate-limit
  • plugin-reports
  • plugin-saml
  • plugin-scheduler
  • plugin-sendgrid
  • plugin-sso
  • plugin-subscription
  • plugin-thumb
  • plugin-transcoder
  • plugin-twilio
  • plugin-waf
  • plugin-watermark

Guides


Architecture


Reference


Licensing


Security


Brand


Operations


Contributing


Admin


Changelog


All commands (52)

Clone this wiki locally