Skip to content

Settings ​

Manage your Slipway instance settings from the dashboard.

Accessing Settings ​

  1. Log into your Slipway dashboard
  2. Click your avatar (bottom left)
  3. Select Settings

Or navigate directly to:

https://slipway.yourdomain.com/settings

Instance Settings ​

General ​

SettingDescription
Instance NameDisplay name (e.g., "Production Slipway")
Instance URLPublic URL for webhooks and CLI
Contact EmailAdmin contact for notifications

Registration ​

SettingDescriptionDefault
Allow SignupsEnable public registrationfalse
Require Email VerificationVerify email before accesstrue
Allowed Email DomainsRestrict signups to domainsEmpty (all)

Example domain restriction:

example.com, company.org

Security Settings ​

Authentication ​

SettingDescriptionDefault
Session TimeoutAuto-logout after inactivity24 hours
Remember Me DurationExtended session length30 days
Max SessionsSessions per user10

Two-Factor Authentication ​

SettingDescriptionDefault
Require 2FAEnforce for all usersfalse
Require 2FA for AdminsEnforce for admins onlytrue

Access Control ​

SettingDescriptionDefault
IP AllowlistRestrict access by IPDisabled
Rate LimitingAPI rate limit100/minute

IP Allowlist Example ​

192.168.1.0/24
10.0.0.0/8
203.0.113.50

Email Settings ​

Configure email for notifications and password reset.

SMTP Configuration ​

SettingDescription
Transportsmtp, resend, or log
SMTP HostMail server hostname
SMTP PortMail server port (usually 587)
SMTP UserAuthentication username
SMTP PasswordAuthentication password
From AddressSender email address
From NameSender display name

Testing Email ​

Click Send Test Email to verify your configuration.

Notification Settings ​

Deployment Notifications ​

SettingDescriptionDefault
Email on DeploySend email on deploymentfalse
Email on FailureSend email on failed deploytrue

Integrations ​

Configure external notification services:

  • Slack: Webhook URL for channel notifications
  • Discord: Webhook URL for channel notifications
  • Custom Webhook: Your own notification endpoint

Backup Settings ​

Automatic Backups ​

SettingDescriptionDefault
EnabledEnable automatic backupstrue
ScheduleBackup frequencyDaily 2 AM UTC
RetentionBackups to keep7

Backup Storage ​

OptionDescription
LocalStore on Slipway server
S3Store in AWS S3 bucket
CustomStore via custom endpoint

S3 Configuration ​

Bucket: my-slipway-backups
Region: us-east-1
Access Key: AKIAIOSFODNN7EXAMPLE
Secret Key: wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY

Log Settings ​

Retention ​

Log TypeDescriptionDefault
Application LogsRuntime logs from apps7 days
Build LogsDocker build output30 days
Deploy LogsDeployment process logs30 days
Audit LogsSecurity/access logs90 days

Log Forwarding ​

Forward logs to external services:

  • Datadog: API key and site
  • Logtail: Source token
  • Custom: Webhook endpoint

Deployment Settings ​

Global Defaults ​

SettingDescriptionDefault
Default Health CheckDefault health check path/
Health Check TimeoutDefault timeout30 seconds
Deploy TimeoutMaximum deploy duration10 minutes
Deployment RetentionDeployments to keep10

Resource Limits ​

SettingDescriptionDefault
Default MemoryMemory per container512 MB
Default CPUCPU shares per container1.0
Build MemoryMemory for builds2 GB

API Settings ​

API Tokens ​

Manage API tokens for CI/CD and automation:

  1. Go to Settings → API Tokens
  2. Click Generate Token
  3. Enter a name (e.g., "GitHub Actions")
  4. Copy the token (shown once)

Token Permissions ​

ScopeDescription
deployTrigger deployments
readRead project/deployment info
adminFull administrative access

Team Settings ​

Team Information ​

SettingDescription
Team NameDisplay name for your team
Team SlugURL identifier

Default Roles ​

RolePermissions
OwnerFull access, can delete team
AdminManage projects, users, settings
DeveloperDeploy, view logs, manage env vars
ViewerRead-only access

Invitations ​

  1. Go to Settings → Team
  2. Click Invite Member
  3. Enter email and select role
  4. Click Send Invitation

Profile Settings ​

Your Profile ​

SettingDescription
Full NameYour display name
EmailYour login email
AvatarProfile picture (Gravatar)

Change Password ​

  1. Go to Settings → Profile
  2. Click Change Password
  3. Enter current and new password
  4. Click Update

Two-Factor Authentication ​

  1. Go to Settings → Profile
  2. Click Enable 2FA
  3. Scan QR code with authenticator app
  4. Enter verification code

Export/Import Settings ​

Export Settings ​

Download your Slipway configuration:

bash
slipway settings:export > slipway-settings.json

Import Settings ​

Restore settings from backup:

bash
slipway settings:import slipway-settings.json

Sensitive Data

Exported settings may contain sensitive information. Handle securely.

What's Next? ​

All open source projects are released under the MIT License.