Archives: Helps

If you need to change the database host or full base URL after installation:

Edit Configuration File

1. Access your running container or server: 

2. Navigate to

3. Edit

4. Update connection details:

5. Save and restart:

Pro Tip: In production, use a dedicated database service with limited privileges (read/write only).
Avoid embedding credentials in scripts—store them in environment variables where possible.

Summary

Post-installation configuration transforms your raw deployment into a production-ready workspace:

• Create a secure admin account and update branding.
• Configure SMTP for notifications and SSL for secure access.
• Set up external storage and reliable backup directories.
• Verify your database and domain settings before onboarding users.

All uploaded files—attachments, images, and reports—are stored in the /app/webroot/uploads directory by default.
Options for Storage

• Local Disk (Default): Fastest for small teams or single servers.
• NFS / NAS: Recommended for multi-node setups or high availability clusters.
• Object Storage (S3-Compatible): For cloud deployments, integrate with AWS S3 or MinIO using mounted volumes.

Docker Compose Example:

Backup Note: Always include /uploads in your backup strategy to retain file attachments alongside the database.

To secure communication between your users and the Orangescrum server, it’s highly recommended to enable HTTPS.

Option 1: Let’s Encrypt (Recommended)

For production:

This automatically issues a free SSL certificate and updates your Apache configuration.

Option 2: Self-Signed SSL (for Testing)

For testing or private networks:

Then configure Apache/Nginx as a reverse proxy to forward HTTPS traffic to the Orangescrum app (usually running on port 8080):

DNS Tip: Ensure an A-record for projects.yourdomain.com points to your server’s IP address before enabling SSL.

To send notifications (task updates, invites, password resets), Orangescrum requires a valid SMTP configuration.
Navigate to:

SMTP Parameters

Setting	Description	Example
SMTP Host	Email service host	smtp.gmail.com
Port	587 (TLS) or 465 (SSL)	587
Username	Your sending email address	noreply@yourdomain.com
Password	App-specific or standard password	********
Encryption	TLS (recommended) or SSL	TLS
From Name	Display name in email headers	Your Organization Notifications

Example configuration snippet:

Test Email: Use the “Send Test Mail” option to verify that SMTP connectivity is working.

Security Note: Always use app-specific passwords or mail relay accounts to avoid exposing corporate credentials.

If SMTP is not ready during setup, you can skip this step and configure it later.

General Settings (Site Name, Timezone, Branding, Logo)

Navigate to:

Here you can configure workspace-level preferences:

• Site Name: Appears in the browser title and email notifications.
• Default Timezone: Used for project timelines, task deadlines, and reports.

(If you enable role-based timezone editing, only Admins can allow users to modify their own timezone.)

• Branding & Logo: Upload your company logo and favicon for a white-label experience.
• Language & Locale: Select default language for global teams.
• Date Format: Choose DD/MM/YYYY or MM/DD/YYYY as per regional preference.

Recommendation: Set your workspace timezone before inviting users to ensure consistent reporting across global teams.

After installation, you’ll be prompted to complete the initial setup wizard. This creates your first administrator account and connects the application to its database.

Default Login

Field	Example
Username / Email	admin@example.com
Password	admin123
Company / Workspace Name	Your Organization Name

You can change the admin credentials immediately after login under:

Tip: Use a unique admin email and a strong password. Avoid reusing credentials from other systems.