Unkaos is a powerful, free-to-use task tracker inspired by the functionality of Jira and YouTrack, designed for development teams and beyond. Enjoy a robust project management tool with flexible customization, all under the Apache 2 license.
🌐 Official cloud: http://unkaos.org | 📦 Install on your server: Installation Guide
Built on stable and modern technologies such as Vue.js 3, Node.js, TypeScript, and PostgreSQL, it ensures a comfortable user experience, including real-time updates with WebSockets and even AI for understanding natural language user requests.
- 📚User Guide
- 💻Developer Documentation
- 📢Info
If you are invited to join an existing project, you should contact your admin. They will add you to the workspace, and you will receive an email with a link to sign in and a temporary password, which you can then change in your user settings.
To find issues, you can use the search field on the 'Issues' page. This field suggests available options at each step of your query construction. The syntax is SQL-like, where each query consists of filters: each filter starts with an issue field name, followed by an operator, and then the value. Filters can be mixed and grouped with logical operators.
When the searched value is a string not from a list of available values, enclose it in quotes (' '). Dates should be formatted as 'yyyy-mm-dd', like '2016-07-16'.
If you're unsure about the correct query structure or prefer not to write it in this manner, don't worry. The Unkaos AI will interpret any prompt to understand what you're seeking and will generate the corresponding query for you.
To create an issue, use the button located near your profile in the upper right corner. Like the profile, this button is accessible from any page.
Additionally, when you're on an issue page, you can create a new one using the clone button found in the top menu, or by using the subtask creation button next to it.
Some configurations of agile boards allow for quick and simple new issue creation directly from a board column, using the '+' button.
To edit an issue, click the pen icon in the top menu. Once in edit mode, you can change the name, description, or project. Note that changing the project will result in a change to the issue number due to its structure, which includes the short project name. Don't forget to use the save button or press Ctrl+S after making changes in edit mode. Other fields, which are located on the right panel, are editable in any mode, and changes are applied as soon as you move the focus away from the field.
The description in edit mode is provided with both a text field for editing with Markdown and a preview. Use a standard Markdown guide if you wish to become more familiar with your options. Feel free to paste images directly into the editable description field.
If you want an image to be available in the issue but not embedded in the description, add it in the attachments section. There, you can attach any files to your issue.
Issue status transitions are available only according to the corresponding workflow.
The button with an eye icon in the top menu enables you to watch the issue - meaning you'll be notified of any changes by email or through messengers.
Additionally, you can manage relations, tags, and time usage in the issue.
There is a brain button located in the bottom center. It opens a panel for AI requests (ctrl + alt + a). You can enter a command in natural language, then press the 'brain' button or press enter to get an AI interpretation. Commands for issue search, creation, and updates are available. Also any answers on the readme can be obtained. Exercise caution and verify it accurately reflects your request for modification commands. Note that this feature allows you to make bulk changes in Unkaos, and it's crucial to ensure it's applied to the correct set of issues.
Agile boards give a visual overview of the project's progress. Drag and drop issues between columns to update their status.
Go to the "Boards" section and click "Create New Board." Choose the board's layout, columns, and which issues it should display.
Dashboards provide a customizable overview of your projects. You can add widgets like issue lists, time reports, and burndown charts.
The issue list widget displays your issues in a list, with options to sort and filter based on various criteria.
Time reports track time spent on tasks. They can be used to generate insights into team productivity and project timelines.
Burndown charts visualize your project's progress against its timeline, helping teams stay on track.
In your user settings, you can configure notifications, update your profile, and change your password. Access settings from the user menu in the top right corner.
As a workspace administrator, you have additional responsibilities and capabilities within Unkaos.
To register a new workspace follow the link on the main page and then the instructions. After your email is verified a workspace is created and you can sign in with the password provided in the email message.
You should start your work with the users page of the main menu. Here you can set a new password for yourself and add team members. After a user is added to the workspace he does not receive any message. To let him know he is registered use the reset password button in that user card. After that a mail with a random password will be sent to that person. The password can be set to a specified value only by the user for himself.
Admins can configure global settings, including project structures, default permissions, and integrations with other tools.
Customize workflows, issue fields, and user roles to fit your team's processes. Access these settings from the admin dashboard.
Manage user accounts and roles from the "Users" section in the admin dashboard. You can add new users, assign roles, and set permissions.
The installation should be performed on a machine with a fresh OS, currently supporting Ubuntu and Debian.
Log into the machine as a user with sudo rights and run the command:
wget -O - https://raw.githubusercontent.com/khvilon/unkaos/master/setup.sh | bashThis will execute the installation script with a wizard that asks for your domain name and the database password.
Additionally, the script will install a Certbot certificate for HTTPS, or you can skip this step if you already have one.
Once Unkaos is installed, you should sign in to the workspace 'Server' using the following URL:
https://[your.domain]/server/login
Log in with the credentials:
- Username:
root@unkaos.org - Password:
rootpass
At the server configs you need first of all to set the email data to activate workspace registration, password updates and notifications.
Also it is of a big help for the user to ask the AI his requests. To make it run you need to configure the integration with GPT server like openai API. Any server with openai protocol can be used. Proxy available. Also you can add a second cheeper model for readme search. Note that the main model should be one of the strongest for today like openai GPT 4 turbo.
Autoupdate at night hours is on by default, it will look for last stable version from the master branch of the repository. You can switch it off or change allowed hours.
Unkaos is built on a robust, scalable, and modern technology stack designed for efficiency and ease of use. At its core, Unkaos uses Vue.js 3 for the front end, providing a reactive and composable user interface. The back end is powered by Node.js, ensuring fast and scalable server-side logic. Data storage is managed by PostgreSQL, known for its reliability and powerful features.
The database structure allows users to access their workspace data while securely isolating other workspaces—each workspace is represented by a schema in the PostgreSQL DB.
Unkaos is designed to handle heavy loads and has no limit on the number of tasks due to its horizontal scalability.
The first service reached by any request from a client is the Gateway. It does not have much functionality, it works like a proxy, checking user permissions in the Cerberus service and connecting to the required service in the local server network.
The back-end services are named following Greek mythology:
Zeus - the king of the Olympic gods, also known as the father of gods. Here, Zeus is the main and largest service, providing a full CRUD API for all objects in the DB. It has the opportunity to automatically set CRUD methods for new tables declared with their relations in the DB.
Hermes - the messenger of the gods, in Unkaos is named the notification service used to send messages via email, Telegram, and Discord. The bots for Telegram and Discord need to be created manually, and then the token is saved in server configs by the server administrator.
Athena - goddess of wisdom, represents the AI service. It gets user prompts, firstly via API integration with a GPT server it tries to classify the request, then it uses the GPT server with a second request depending on the result of the first one. It can be a prompt for help with readmes or a command to search or update issues.
Ossa - a goddess associated with rumors, capturing every whisper of the earth and air. The corresponding task tracker service similarly gathers info about changes in the DB by publications and transfers it to shared memory for other services' use. It also provides a real-time update for the issue page through web sockets.
Eileithyia - is the Greek goddess associated with childbirth. The Eileithyia service is responsible for performing new workspace registrations - its requests do not need authentication through Cerberus.
We welcome contributions from the community! Whether you're interested in fixing bugs, adding new features, or improving documentation, your help is appreciated.
- Fork the repository: Start by forking the Unkaos repository on GitHub.
- Clone your fork: Clone your fork to your local machine for development.
- Create a new branch: Make your changes in a new git branch.
- Commit your updates: Commit your changes with clear, descriptive commit messages.
- Submit a pull request: Push your changes to your fork and submit a pull request to the main Unkaos repository.
If your changes includes DB migrations, place it into a file named m.sql in the /server/db folder.
A V2 API is currently in development. Upon release, it will include an OpenAPI specification, providing a comprehensive and interactive documentation for developers.
For the moment, you can leverage requests captured from developer tools for temporary automation tasks. However, it is recommended to wait for the V2 API for serious development efforts to ensure compatibility and access to the full suite of new features.
Stay tuned for updates and the detailed documentation on how to utilize the Unkaos API effectively.
Stay updated with the latest news and updates from Unkaos. Join our Telegram channel, or reach out to the author directly.
🔔News: https://t.me/unkaos_info
📧 Contact: n@khvilon.ru | @khvilon