doc/pages/01.administrate/05.install/install.md

title	template	taxonomy	never_cache_twig	twig_first	process	page-toc	routes
Install YunoHost	docs	category docs	true	true	markdown twig true true	active depth true 2	default aliases /install /docker /install_iso /install_on_vps /install_manually /install_on_raspberry /install_on_arm_board /install_on_debian /install_on_virtualbox /plug_and_boot /burn_or_copy_iso /boot_and_graphical_install /postinstall

{% set arm, at_home, regular, rpi2plus, rpi1, rpi0, arm_sup, arm_unsup, vps, vps_debian, vps_ynh, virtualbox, internetcube, docker = false, false, false, false, false, false, false, false, false, false, false, false, false, false %} {% set hardware = uri.param('hardware') %} {% if hardware == '' %} {% set hardware = 'vps_debian' %} {% endif %}

{% if hardware == 'regular' %} {% set regular = true %} {% elseif hardware == 'internetcube' %} {% set arm, arm_sup, internetcube = true, true, true %} {% elseif hardware == 'rpi2plus' %} {% set arm, rpi2plus = true, true %} {% elseif hardware == 'rpi1' %} {% set arm, rpi1 = true, true %} {% elseif hardware == 'rpi0' %} {% set arm, rpi0 = true, true %} {% elseif hardware == 'arm_sup' %} {% set arm, arm_sup = true, true %} {% elseif hardware == 'arm_unsup' %} {% set arm, arm_unsup = true, true %} {% elseif hardware == 'vps_debian' %} {% set vps, vps_debian = true, true %} {% elseif hardware == 'vps_ynh' %} {% set vps, vps_ynh = true, true %} {% elseif hardware == 'virtualbox' %} {% set at_home, virtualbox = true, true %} {% elseif hardware == 'docker' %} {% set docker = true %} {% endif %}

{% if arm or regular %} {% set at_home = true %} {% endif %}

Select the hardware on which you want install YunoHost : [div class="flex-container"]

[div class="flex-child hardware{%if virtualbox %} active{% endif %}"] [figure caption="VirtualBox"][/figure] [/div]

[div class="flex-child hardware{%if rpi2plus or rpi1 or rpi0 %} active{% endif %}"] [figure caption="Raspberry Pi"][/figure] [/div]

[div class="flex-child hardware{%if arm_sup or arm_unsup or internetcube %} active{% endif %}"] [figure caption="ARM board"][/figure] [/div]

[div class="flex-child hardware{%if regular %} active{% endif %}"] [figure caption="Regular computer"][/figure] [/div]

[div class="flex-child hardware{%if vps_debian or vps_ynh %} active{% endif %}"] [figure caption="Remote server"][/figure] [/div]

[/div] [div class="flex-container pt-2"]

{% if rpi2plus or rpi1 or rpi0 %} [div class="flex-child hardware{%if rpi2plus %} active{% endif %}"] [figure caption="Raspberry Pi 2, 3 or 4"][/figure] [/div]

[div class="flex-child hardware{%if rpi1 %} active{% endif %}"] [figure caption="Raspberry Pi 1"][/figure] [/div]

[div class="flex-child hardware{%if rpi0 %} active{% endif %}"] [figure caption="Raspberry Pi zero"][/figure] [/div] {% elseif arm_sup or arm_unsup or internetcube %}

[div class="flex-child hardware{%if internetcube %} active{% endif %}"] [figure caption="Internet cube With VPN"][/figure] [/div]

[div class="flex-child hardware{%if arm_sup and not internetcube %} active{% endif %}"] [figure caption="Olinuxino lime1&2 or Orange Pi PC+"][/figure] [/div]

[div class="flex-child hardware{%if arm_unsup %} active{% endif %}"] [figure caption="Others boards"][/figure] [/div] {% elseif vps_debian or vps_ynh %}

[div class="flex-child hardware{%if vps_debian %} active{% endif %}"] [figure caption="VPS or dedicated server with Debian 10"][/figure] [/div]

[div class="flex-child hardware{%if vps_ynh %} active{% endif %}"] [figure caption="VPS or dedicated server with YunoHost pre-installed"][/figure] [/div]

{% endif %}

[/div]

{% if docker %} !! YunoHost doesn’t support Docker officially since issues with versions 2.4+. In question, YunoHost 2.4+ doesn’t work anymore on Docker because YunoHost requires systemd and Docker has chosen to not support it natively (and there are other problems link to the firewall and services). !! !! We strongly discourage you to run YunoHost on docker with those images

Community images

However, community images exist and are available on Docker Hub:

• AMD64 (classic) (ancienne version de YunoHost)
• I386 (old computers) (ancienne version de YunoHost)
• ARMV7 (Raspberry Pi 2/3 ...) (ancienne version de YunoHost)
• ARMV6 (Raspberry Pi 1) (old yunoHost version) {% else %}

Pre-requisites

{% if regular %}

• A x86-compatible hardware dedicated to YunoHost: laptop, nettop, netbook, desktop with 512MB RAM and 15GB capacity (at least) {% elseif rpi2plus %}
• A Raspberry Pi 2, 3 or 4 with 512MB RAM (at least) {% elseif rpi1 %}
• A Raspberry Pi 1 with 512MB RAM (at least) {% elseif rpi0 %}
• A Raspberry Pi zero with 512MB RAM (at least) {% elseif arm_sup %}
• A VPN with a dedicated IP and a .cube file
• An Orange Pi PC+ or an Onlinuxino Lime 1 or 2 {% elseif arm_sup %}
• An Orange Pi PC+ or an Onlinuxino Lime 1 or 2 {% elseif arm_unsup %}
• An ARM board with 500MHz CPU and 512MB RAM (at least) {% elseif vps_debian %}
• A dedicated or virtual private server with Debian 10 (with kernel >= 3.12)) preinstalled, 512MB RAM and 15GB capacity (at least) {% elseif vps_ynh %}
• A dedicated or virtual private server with yunohost preinstalled, 512MB RAM and 15GB capacity (at least) {% elseif virtualbox %}
• An x86 computer with VirtualBox installed and enough RAM capacity to be able to run a small virtual machine with 512MB RAM and 8GB capacity (at least) {% endif %} {% if arm %}
• A power supply (either an adapter or a MicroUSB cable) for your board;
• A microSD card: 16GB capacity (at least) and Class 10 speed rate are highly recommended (like the Transcend 300x); {% endif %} {% if regular %}
• A USB stick of at least 1GB capacity OR a standard blank CD {% endif %} {% if at_home %}
• A reasonable ISP, preferably with a good and unlimited upstream bandwidth {% if rpi0 %}
• An usb OTG or a wifi dongle to connect your Raspberry Pi Zero {% else %}
• An ethernet cable (RJ-45) to connect your server to your router. {% endif %}
• A computer to read this guide, write the image and access to your server. {% endif %} {% if not at_home %}
• A computer or a smartphone to read this guide and access to your server. {% endif %}

{% if virtualbox %} ! N.B. : Installing YunoHost in a VirtualBox is usually intended for testing. To run an actual server on the long-term, you usually need a dedicated physical machine (old computer, ARM board...) or a VPS online. {% endif %}

{% if at_home %}

Download the YunoHost image

{% if regular %} !!! Particular case : If your server has no graphic card, prepare iso for booting with serial port. {% elseif virtualbox %} !!! If your host OS is 32 bits, be sure that you downloaded the 32-bit image previously. {% endif %}

{% if not virtualbox %}

Flash the YunoHost image

Now that you downloaded the image of YunoHost, you should flash it on {% if arm %}a SD card{% else %}a USB stick or a CD.{% endif %}

{% if arm %} {% else %} {% endif %}

[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Recommended) With Etcher"]

Download Etcher for your operating system and install it.

Plug your USB stick, select your YunoHost ISO and click "Flash" [/ui-tab] [ui-tab title="With UNetbootin"]

Download UNetbootin for your operating system and install it.

Put your USB stick on, select your YunoHost ISO and click "OK"

[/ui-tab] [ui-tab title="With dd"]

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

[/ui-tab] {% if regular %} [ui-tab title="Burning a CD/DVD"] For older devices, you might want to burn a CD/DVD. The software to use depends on your operating system.

• On Windows, use ImgBurn to write the image file on the disc

• On macOS, use Disk Utility

• On GNU/Linux, you have plenty of choices, like Brasero or K3b [/ui-tab] {% endif %} [/ui-tabs]

{% else %}

Create a new virtual machine

---

Change network settings

NB: You must carry out this step. If not, the install will fail.

Go to Settings > Network:

• Select Bridged adapter

• Select your interface's name:

  wlan0 if you are connected wirelessly, else eth0.

---

{% endif %}

{% if arm %}

Power up the board

• Plug the ethernet cable. !!! Note: if you want the network configuration to be set up automatically, you have to plug your server with an Ethernet cable right behind your main router.[details="If you have confident in your skills, it's possible to connect your server through WiFi"]If you want your server to connect using WiFi, you may configure it as explained here. Alternatively, you can mount the second partition of the SD card and edit the wpa-supplicant.conf file prior to boot the card for the first time. On Windows you can use Paragon ExtFS for this - just don't forget to unmount everytime for changes to take effect.[/details]
• Plug the SD card
• Power up the board !!! You can also boot your server with a screen and keyboard connected to it to see how the boot process is going on.[details="See more"]This method can also be useful to troubleshoot issues and to have a direct access to it.[/details]
• Wait a couple minutes for your server to boot and to resize automatically partition
• Make sure that your computer (desktop/laptop) is connected to the same local network (i.e. same internet box) as your server.

{% elseif virtualbox %}

Boot up the virtual machine

Start the virtual machine

You will have to select your ISO image here, then you should see the YunoHost's boot screen.

! If you encounter the error "VT-x is not available", you need probably need to enable Virtualization in the BIOS of your computer.

{% else %}

Boot the machine on your usb stick and run the installation

• Plug the ethernet cable. !!! Note: if you want the network configuration to be set up automatically, you have to plug your server with an Ethernet cable right behind your main router. The wireless connections are not supported yet, and if you use intermediate routers, the network ports opening will not be automatic: Your server will not be accessible externally.
• If your server was under windows 8+, go on Advanced startup options of windows to ask windows for booting on the USB stick.
• Boot up your server with the USB stick or a CD-ROM inserted, and select it as bootable device by pressing one of the following keys (hardware specific):
  <ESC>, <F9>, <F10>, <F11>, <F12> or <DEL> {% endif %}

{% if regular or virtualbox %}

Launch graphical install

You should see a screen like this:

[figure class="nomargin" caption="Preview of the ISO menu"] [/figure]

1. Select Graphical install
2. Select your language, your location and your keyboard layout
3. If a partitioning screen appears, confirm. !! This will totally erase the data on your hard drive
4. Let the installer do the rest, it will download required packages and install them.

! If it fails, you probably have an Internet connection issue.  
! Check that your computer is physically connected and retry.

5. It should reboot automatically.

TODO what to do with default credentials info ?

{% endif %}

{% elseif vps_debian %}

Run the install script

Once you have access to a command line on your server (either directly or through SSH), you can install YunoHost by running command as root :

curl https://install.yunohost.org | bash

!!! If curl is not installed on your system, you might need to install it with apt install curl.
!!! Otherwise, if the command does not do anything, you might want to apt install ca-certificates

---

!!! Note for advanced users concerned with the curl|bash approach:
!!! If you strongly object to the curl|bash way (and similar commands) of installing software, consider reading "Is curl|bash insecure?" on Sandstom's blog, and possibly this discussion on Hacker News.

{% endif %}

Proceed with initial configuration or restore an archive

!!! if you are in the process of restoring a server from scratch and you have a yunohost-made backup, you can skip this process and follow through with the "restoring during the postinstall" step, in the backup page.

[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="From the web interface"] You can perform the post-installation with the web interface by entering in your browser {%if at_home %} {% if internetcube %}internetcube.local{% else %}yunohost.local{% endif %} OR the local IP address of your server if it is on your local network (e.g. at home !). The address typically looks like 192.168.x.y (see finding your local IP){% else %} the public IP address of your server if your server is not on your local network. Typically, if you own a VPS, your VPS provider should have given you the IP of the server.{% endif %}

! 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. PLEASE, don't take the habit to blindly accept this kind of alert !

{% if not internetcube %} You should then land on this page :

[figure class="nomargin" caption="Preview of the Web initial configuration page"] [/figure]

{% endif %} [/ui-tab] [ui-tab title="From the command line"]

You can also perform the postinstallation with the command yunohost tools postinstall directly on the server, or via SSH.

[figure class="nomargin" caption="Preview of the command-line post-installation"] [/figure]

[/ui-tab] [/ui-tabs]

{% if not internetcube %}

[details="Details on information asked during initial configuration"]

Main domain

This is the first domain name linked to your YunoHost server, but also the one which will be used by your server's users to access the authentication portal. It will thus be visible by everyone, choose it wisely.

• If you do not have a domain name, or if you want to use the YunoHost's DynDNS service, choose a sub-domain of .nohost.me, .noho.st or .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.

• If you do know what DNS is, you probably want to configure your own domain name here. In this case, please refer to the DNS page page for more informations.

• If you don't own a domain name and don't want a .nohost.me, .noho.st or .ynh.fr, you can use a local domain. More information on how to setup a local domain can be found here.

Administration password

This password will be used to access to your server's administration interface. You would also use it to connect via SSH or SFTP. In general terms, this is your system's key, choose it carefully. [/details]

At this step, if you got so far and saw 'YunoHost has been successfully installed' (web postinstall) or 'YunoHost has been correctly configured', then congratulations!

Create a first user

You should create a first user.

!!! This user will received special emails root@, admin@, postmaster@, webmaster@ and abuse@. These emails are used to send you mails about your server.

[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="From the web interface"] [/ui-tab] [ui-tab title="From the command line"] You can create your first user by running this command, it will ask you some information.

yunohost user create johndoe

[/ui-tab] [/ui-tabs] {% endif %}

Run diagnostic and fix DNS or Router issues if needed

To diagnose that all critical aspects of your server are properly configured, you should run a diagnosis. After the first run, the diagnosis will run twice a day to alert you if something break. Email are sent to the first user created.

You need to fix red issues if you want to be able to access your server outside your local network.

!!! If an alert is not relevant you should go on Webadmin > Diagnosis and click on the ignore button for this specifc unrelevant issue.

[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="(Recommended) From the web interface"] To run a diagnosis, go on Web Admin in the Diagnosis section. You should get a screen like this :

[figure class="nomargin" caption="Preview of the diagnostic panel"] [/figure]

[/ui-tab] [ui-tab title="From the command line"]

yunohost diagnosis run

[/ui-tab] [/ui-tabs]

Get a Let's Encrypt certificate

If your DNS and router configuration are ok, you can next ask for a Let's Encrypt certificate.

For more detailled instructions or know more about TLS certificate, see here

[ui-tabs position="top-left" active="0" theme="lite"] [ui-tab title="From the web interface"]

[figure class="nomargin" caption="Preview of the diagnostic panel"] [/figure]

[/ui-tab] [ui-tab title="From the command line"]

yunohost domain cert-install

[/ui-tab] [/ui-tabs] {% endif %}

Congratz!

You have now a pretty well configured server. You can now try to install apps if you need (don't keep apps on your server if you don't need it) and configure a backup.