Redmine¶

In this article

• Redmine. Core Features
• Deployment Features
• Getting Started After Deploying Redmine
• First Login and Password Change
• Administrator Profile Setup
• Main Interface Sections of Redmine
• Ordering a server with Redmine using the API

Redmine. Core Features¶

• Project and Task Management: Create projects, assign tasks, set priorities, track execution time and progress;
• Issue Tracking System: Full-featured bug tracker with classification, assignment, and status tracking capabilities;
• Version Control Management: Integration with version control systems (Git, SVN, Mercurial), viewing commits, and linking them to issues;
• Flexible Role and Permission System: Detailed access rights configuration for different users and groups;
• Wiki System: Built-in documentation support with text formatting and file attachments;
• Forums and News: Tools for communication within projects;
• Calendar and Gantt Charts: Visualization of project timelines and resource planning;
• Custom Fields: Ability to add custom fields for tasks and projects;
• Email Integration: Email notifications and task creation via email.

Deployment Features¶

• Containerized Deployment - the platform is delivered with Docker and all necessary containers for full functionality.
• Key Containers:
  • redmine - main Redmine application (version 6.0.5, Ruby 3.3.8);
  • redmine-mysql - MySQL database 8.0;
  • redmine-nginx - Nginx web server with automatic SSL certificates (jonasal/nginx-certbot:latest).
• Key Directories:
  • /opt/redmine/ - main installation directory with Docker Compose configuration;
  • /data/nginx/user_conf.d/ - Nginx configuration files;
  • /data/nginx/nginx-certbot.env - environment variables for SSL certificates;
  • Inside the container: /usr/src/redmine/ - root directory of Redmine application.
• Network Architecture:
  • External ports: 80 (HTTP), 443 (HTTPS);
  • Automatic retrieval of SSL certificates via Let's Encrypt.

Getting Started After Deploying Redmine¶

After payment, an email notification about server readiness will be sent to the email registered at registration. It will contain the VPS IP address as well as login and password for connection. Our company's clients manage equipment through the server management panel and API — Invapi.

Authorization data can be found in the Info >> Tags section of the server control panel or in the sent email:

• Web Interface Access Link for Redmine: in the webpanel tag;
• Login and Password for server management: sent via email upon server handover.

First Login and Password Change¶

Access to Web Interface¶

1. Open a web browser and navigate using the link from the webpanel tag;
2. On the Redmine start page, click the Sign in link in the top right corner;
3. Enter default credentials:
   • Login: admin
   • Password: admin
4. Click the Login button:

Mandatory Password Change¶

1. After logging in, you'll see a notification: Your password has expired or the administrator requires you to change it;
2. On the password change page, fill out the fields:
   • Current password - enter current password admin;
   • New password - enter a new secure password (minimum 8 characters);
   • Confirmation - confirm the new password;
3. Click the Apply button to save changes:

After successfully changing your password, you will be redirected to your profile.

Administrator Profile Setup¶

Basic Information¶

In the My account section, you can configure:

1. Personal Data:

   • First name - user's first name;
   • Last name - user's last name;
   • Email - email address for notifications;
   • Language - interface language.

2. Two-factor Authentication:

   • Enable it for additional security via the Enable authenticator app link.

Notification Settings¶

In the Email notifications section, configure:

• Event Notifications - select which events to receive notifications about;
• Auto watch - automatically track tasks you created or participated in;
• Check options for automatic tracking:
  • Issues I created - tasks I created;
  • Issues I contributed to - tasks I participated in.

Personal Preferences¶

In the Preferences section, set:

• Time zone - your time zone;
• Display comments - order of comment display;
• Hide my email address - hide email from other users;
• Warn me when leaving a page with unsaved text - warning when leaving a page with unsaved text;
• Font used for text areas - font for text areas;
• Number of recently used projects in jump box - number of recently used projects in the quick access field.

After making changes, click the Save button to save settings.

Main Interface Sections of Redmine¶

Navigation Menu¶

The main menu is located at the top of the interface:

• Home - system overview home page;
• My page - user's personal page;
• Projects - list of all available projects;
• Administration - administrative functions (available only to administrators);
• Help - help information.

Administrative Functions¶

Upon first entering the Administration section, the system will display a notification about the need to load default configuration:

To initialize the system:

1. Select the language from the Language dropdown list (default is English);
2. Click the Load the default configuration button to load standard settings.

After loading the configuration, the following functions become available in the Administration section:

• Projects - project management;
• Users - user management;
• Groups - group management;
• Roles and permissions - role and access rights configuration;
• Trackers - task type setup;
• Issue statuses - issue status settings;
• Workflow - workflow process configuration;
• Custom fields - custom field setup;
• Enumerations - enumerations (priorities, activities, etc.);
• Settings - system-wide settings;
• Ldap authentication - LDAP authentication setup;
• Plugins - plugin management;
• Information - system information.

Creating the First Project¶

After loading the standard configuration, you can create your first project:

1. Go to Projects → New project;
2. Fill out the basic project fields:

Required Fields:

• Name - project name (required field, marked with a red asterisk);
• Identifier - unique project identifier:
  • Length of 1 to 100 characters;
  • Only lowercase letters (a-z), numbers, dashes, and underscores allowed;
  • Cannot be changed after saving;
  • Used in the project URL.

Additional Fields:

• Description - project description with formatting support (toolbar includes bold text, italics, lists, links);
• Homepage - project website (optional).

Access Settings:

• Public - make the project public (checked by default):
  • Public projects and their content are openly accessible on the network;
  • Uncheck to create a private project;
• Inherit members - inherit members from parent project (for subprojects).

Project Modules: Select active modules for the project (all checked by default):

• Issue tracking - task and error tracking;
• Time tracking - work time accounting;
• News - project news;
• Documents - document management;
• Files - file storage;
• Wiki - wiki pages for documentation;
• Repository - version control system integration;
• Forums - discussion forums;
• Calendar - project calendar;

• Gantt - Gantt charts for planning.

• After filling in all necessary fields, click:

  • Create - to create the project;
  • Create and add another - to create a project and move on to creating the next one.

Ordering a server with Redmine using the API¶

To install this software using the API, follow these instructions

Some of the content on this page was created or translated using AI.