Select the hardware on which you want install YunoHost :
The links to the images are currently broken. While we resolve the issue, you can find them directly on https://build.yunohost.org/
If you wish to check the validity of our signed images, you can download our public key.
Now that you downloaded the image of YunoHost, you should flash it on a microSD card
Download Etcher for your operating system and install it.
Plug your SD card, select your image and click "Flash"
Download USBimager for your operating system and install it.
Plug your SD card, select your image and click "Write"
If you are on GNU/Linux / macOS and know your way around command line, you may also flash your USB stick or SD card with
dd. You can identify which device corresponds to your USB stick or SD card with
fdisk -l or
lsblk. A typical SD card name is something like
/dev/mmcblk0. BE CAREFUL and make sure you got the right name.
Then run :
# Replace /dev/mmcblk0 if the name of your device is different... dd if=/path/to/yunohost.img of=/dev/mmcblk0
If you are in the process of restoring a server using a YunoHost backup, you should skip this step and instead restore the backup instead of the postinstall step.
In an internet browser, type
yunohost-2.local, and so on if multiple YunoHost servers are on your network).
If this doesn't work, you can look for the the local IP address of your server. The address typically looks like
192.168.x.y, and you should therefore type
https://192.168.x.y in your browser's address bar.
During the first visit, you will very likely encounter a security warning related to the certificate used by the server. For now, your server uses a self-signed certificate. You will later be able to add a certificate automatically recognized by web browsers as described in the certificate documentation. For now, you should add a security exception to accept the current certificate. (Though, PLEASE, do not take the habit of blindly accepting this kind of security alert!)
You should then land on this page :
You can also perform the postinstallation with the command
yunohost tools postinstall directly on the server, or via SSH.
This will be the domain used by your server's users to access the authentication portal. You can later add other domains, and change which one is the main domain if needed.
If you're new to self-hosting and do not already have a domain name, we recommend using a .nohost.me / .noho.st / .ynh.fr (e.g.
homersimpson.nohost.me). Provided that it's not already taken, the domain will be configured automatically and you won't need any further configuration step. Please note that the downside is that you won't have full-control over the DNS configuration.
If you already own a domain name, you probably want to use it here. You will later need to configure DNS records as explained here.
Yes, you have to configure a domain name. If you don't have any domain name and don't want a .nohost.me / .noho.st / .ynh.fr either, you can set up a dummy domain such as
yolo.test and tweak your
/etc/hosts file such that this dummy domain points to the appropriate IP, as explained here).
Once the postinstall is done, you should be able to actually log in the web admin interface using the administration password.
So far, your server now has an
admin user - but
admin is not a "regular" user and can't be used to log on the user portal.
Let's therefore add a first "regular" user.
The first user you create is a bit special : it will receive emails sent to
email@example.com. These emails may be used to send technical informations or alerts.
Go in Users > Click on "+ New User" button
yunohost user create johndoe
The diagnosis system is meant to provide an easy way to validate that all critical aspects of your server are properly configured - and guide you in how to fix issues. The diagnosis will run twice a day and send an alert if issues are detected.
N.B. : don't run away ! The first time you run the diagnosis, it is quite expected to see a bunch of yellow/red alerts because you typically need to configure DNS records (if not using a
ynh.fr domain), add a swapfile if not enough ram and/or port forwarding.
If an alert is not relevant (for example because you don't intend on using a specific feature), it is perfectly fine to flag the issue as 'ignored' by going in the webadmin > Diagnosis, and clicking the ignore button for this specifc issue.
To run a diagnosis, go on Web Admin in the Diagnosis section. Click Run initial diagnosis and you should get a screen like this :
yunohost diagnosis run yunohost diagnosis show --issues --human-readable
Once you configured DNS records and port forwarding (if needed), you should be able to install a Let's Encrypt certificate. This will get rid of the spooky security warning from earlier for new visitors.
For more detailed instructions, or to lean more about SSL/TLS certificates, see the corresponding page here.
Go in Domains > Click on your domain > SSL Certificate
yunohost domain cert install
You now have a pretty well configured server. If you're new to YunoHost, we recommend to have a look at the guided tour. You should also be able to install your favourite applications. Don't forget to plan backups !
Found errors? Think you can improve this documentation? Simply click the Edit link at the top of the page, and then the icon on Github to suggest changes.