Repository files navigation

Simple NAS web dashboard designed for ARM devices
Installation guide »

Report Bug ·Request Feature

• About the Project
  • Description
  • Features list
  • Branches
• Installation
• Features
  • Messages
• Development
• Contributing
• Application logs
• Questions and answers
• Translation
• License
• Built With

Armnas is a lightweight web NAS dashoard designed for ARM devices. It was created for people who do not want to install another operating system in order to have a NAS dashboard. The installation script is very simple and the average installation time is around 5 minutes. Uninstallation is even easier and takes less than 1 minute. With Armnas, you can buy a Raspberry Pi, a portable drive and enjoy a home NAS for <$100 dollars. Every release is tested on Raspberry pi 4 (Raspbian ARM32), Odroid XU4 (Armbian ARM32) and VMWare (Debian x64).
Languages: English, Polish.

• System info
• Quick unmount/mount ofpartitions
• Partitions automount (on startup)
• Samba configuration
• Torrent client (transmission)
• Cron jobs configuration
• Messages system
• Keycloak (optional)

• main: main releases - tested onArmbian (ARM32),Raspbian (ARM32) andDebian x64.
• develop: daily builds - can be unstable.

If you want to install armnas, please run theses two commands:
sudo wget https://raw.githubusercontent.com/h4570/armnas/main/install.sh
sudo chmod +x install.sh && sudo ./install.sh
If you want to get more details about installation/uninstallation and update procedure, please go toInstallation guide.

If you want to uninstall armnas, please run theses two commands:
sudo wget https://raw.githubusercontent.com/h4570/armnas/main/uninstall.sh
sudo chmod +x uninstall.sh && sudo ./uninstall.sh

System information with latest CPU temperature, RAM usage, etc.
Refresh interval can be set inTweak mode.

Partitions module is used to mount/unmount your HDDs, pendrives, etc. very quickly.
Partitions can be also set inautomount mode, which will mount you partitions at startup.
Custom names of the partitions can be set inTweak mode.

Cron jobs allows you toschedule your custom commands, programs or bash scripts.

Samba is used to share some directories or mounted partitions via SMB protocole. You can easilymount these shares in your Windows machine.

Transmission is a simple torrent client with web dashboard.
Incomplete directory and complete directory can be set inTweak mode.

Messages system is used toadd notifications directly from your bash scripts, programs and bash terminal.
For example, you can create backup script and send the result (success/fail) to Armnas. After it, Armnas will show new notification in navbar area for you.
Please checkMessages to get more details.

Keycloak is an Open Source Identity and Access Management solution for modern Applications and Services.
More information

Armans actively uses bash to execute commands on the target system. To facilitate the development of Armnas, an SSH module has been added. There is logic in the code that checks the current system. When it is Windows, Armnas automatically tries to execute commands on target system via SSH.
Please checkDevelopment guide to get more details.

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make aregreatly appreciated.

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/amazing-feature)
3. Commit your Changes (git commit -m 'Add some amazing-feature'), please try to use commit inAngular commit convention style
4. Push to the Branch (git push origin feature/amazing-feature)
5. Open a Pull Request

When you encounter a problem in the application, you can double-check what happened in the log file.
This file is located in:/var/www/armnas/backend/WebApi/webapi.log
The file is cleaned before each Armnas backend run!

You can find list of the most common problems inQuestions and answers file.

If you want to contribute and translate Armans to another language, here is the todo list.

1. Create file with your language translations in:/frontend/web-app/src/assets/i18n/xx_XX.json
2. Add translation for name of your language in (navbar->language):/frontend/web-app/src/assets/i18n/xx_XX.jsonand other languages
3. Add button with your language in (line 87):/frontend/web-app/src/app/components/navbar/navbar.component.html

Distributed under the Apache License 2.0 License. SeeLICENSE for more information.

• .NET 8.0.11
• Angular 11
• Caddy
• oData
• Swagger

Project Link:https://github.com/h4570/armnas
Sandro Sobczyński -sandro.sobczynski@gmail.com