Help
Small team, big heart! Your queries count.
Explore this page or join our Telegram. Patience appreciated!
Install Overview
Install Overview
System Requirements
System Requirements
How to Install our OS?
How to Install our OS?
A step-by-step guide to help you install our Nirvati OS-based on your computer.
Let us guide youΒ ποΈ
Let us guide youΒ ποΈ
FAQs
FAQs
Terminology
GUI = Graphical user interface β in this case a web browser
CLI = Command line interface β in this case a terminal
How to access your node (GUI)?admin2023-11-18T23:15:22+00:00
- Open any browser
- Type in the address bar
citadel.local
or your nodeβs IP address β for help see Need your nodeβs IP address? - type your password
I have installed Citadel OS, what now?admin2023-11-18T23:17:07+00:00
- Open the browser from any of your devices
- Type in the address bar
citadel.local
or your node IP address β for help see Need your nodeβs IP address? - type in your password
- enjoy Citadel OS
Need your nodeβs IP address?admin2023-11-18T23:16:31+00:00
- Install Angry IP Scanner here
- Open Angry IP Scanner and press βStartβ
- Identify the IP address of your node looking at βHostnameβ and βPingβ (keep in mind that Ethernet has lower ping than Wifi)
Want to SSH into your node? (CLI)admin2023-11-18T23:15:55+00:00
- Open the Terminal on any device you want to use for SSH into your node
- write
ssh [account_name]@citadel
- Replacing
[account_name]
withcitadel
for Citadel OS v0.2.x, andnirvati
for Citadel OS v0.3.x (Nirvati technical preview). - If this fails, try
ssh [account_name]@citadel.local
orssh [account_name]@[ip_address]
, replacing[ip_address]
with the IP address of your node β for help see Need your nodeβs IP address?
Want to shutdown your node? (GUI)admin2023-11-18T23:14:19+00:00
- Access your node β for help see How to access your node (GUI)?
- go to βSettingsβ
- press βShutdownβ
Want to restart your node? (GUI)admin2023-11-18T23:13:42+00:00
- Access your node β for help see How to access your node (GUI)?
- go to βSettingsβ
- press βRestartβ
Want to update Citadel (GUI)?admin2023-11-18T23:13:10+00:00
- Access your node β for help see How to access your node (GUI)?
- go to βSettingsβ
- press βCheck for updatesβ, then βInstall Nowβ if there are any updates
Need logs for troubleshooting (GUI)?admin2023-11-18T23:12:40+00:00
- Access your node β for help see How to access your node (GUI)?
- go to βSettingsβ
- under βTroubleshootingβ press βStartβ
Need logs for troubleshooting (CLI)?admin2023-11-18T23:12:11+00:00
- SSH into your node β for help see Want to SSH into your node?
- write
sudo ~/citadel/scripts/debug --upload --no-tor
Want to start Citadel (CLI)?admin2023-11-18T23:11:41+00:00
- SSH into your node β for help see Want to SSH into your node?
- write
sudo ~/citadel/scripts/start
Want to stop Citadel (CLI)?admin2023-11-18T23:10:51+00:00
- SSH into your node β for help see Want to SSH into your node?
- write
sudo ~/citadel/scripts/stop
Want to install an app (CLI)?admin2023-11-18T23:10:57+00:00
- SSH into your node β for help see Want to SSH into your node?
- write
sudo ~/citadel/scripts/app install [app_name]
replacing[app_name]
with the name of the app you wish to install e.g.fulcrum
Want to do a full reset (BACKUP EVERYTHING FIRST) (CLI)?admin2023-11-18T23:11:04+00:00
- Backup every data that is important on a secure device different from your node.
- SSH into your node β for help see Want to SSH into your node?
- write
sudo ~/citadel/scripts/stop
&& sudo rm -rf ~/citadel/app-data/* && sudo rm -f
~/citadel/statuses/configured ~/citadel/db/user.json
~/citadel/db/citadel-seed/seed && sudo ~/citadel/scripts/start
&& sudo ~/citadel/scripts/start
Need additional help (GUI)?admin2023-11-18T23:06:55+00:00
- Generate logs for Troubleshooting GUI β for help see Need logs for troubleshooting (GUI)?
- Press βDownload logsβ
- Join the Citadelβs Telegram Group, describe in detail what happened and attach the logs file.
- have patience π We are a small team, but we are trying our best to get back to you asap!
Need additional help (CLI)?admin2023-11-18T23:05:05+00:00
- Generate logs for Troubleshooting CLI β for help see Need logs for troubleshooting (CLI)?
- Copy the sharable link you get
- Join the Citadelβs Telegram Group, describe in detail what happened and attach the logs file.
- have patience π We are a small team, but we are trying our best to get back to you asap!
ποΈ
ποΈ