====== OpenRC ======

OpenRC is an init system for operating systems such as GNU/Linux, GNU/Hurd and Unix. It is a [[https://en.wikipedia.org/wiki/POSIX|POSIX]]-compatible alternative solution to the problematic [[https://wiki.hyperbola.info/doku.php?id=en:philosophy:systemd_denial|systemd]] software-suite. OpenRC was created by the Gentoo GNU/Linux development team. Its purpose is to enable, disable and/or manage the services of the operating system.

OpenRC emerged at the end of 2007, ((for more details go to: [[https://github.com/OpenRC/openrc/blob/master/HISTORY.md#openrc-history|OpenRC History]])) when Roy Marples retired as a Gentoo GNU/Linux developer. However, he wanted to keep the **baselayout-2** project as an independent project. The Gentoo Project Board has allowed it to continue being maintained as an external project, once the project name was modified to OpenRC with the two-clause BSD license.

In 2010, OpenRC was transferred back to the development of Gentoo GNU/Linux, after Roy Marples decided that he would not keep his project. William Hubbs and several other developers took over OpenRC from this point, with 0.8.x being the first release made by the new team. In 2011, OpenRC returned to the stable Gentoo GNU/Linux tree.

In 2013, the OpenRC team became independent from Gentoo GNU/Linux again and changed the primary development to <color #B90B0B/#FFDDDD>GitHub</color>.

===== Features =====

OpenRC provides a number of interesting features:
  * Compatible with //UNIX// philosophy
  * Portable to non-GNU/Linux systems
  * Cgroups ([[https://en.wikipedia.org/wiki/Cgroups|control groups]]) support
  * Parallel service initialization
  * Dependency-based initialization
  * Automatic dependency calculation
  * Enables per-service resource limiting and unlimiting
  * Sections of split configurations: **init.d** and **conf.d**
  * Well-explained and self-explanatory configuration files
  * Startup scripts are extensible and customizable
  * Designed to be 100% compatible with virtualization environments
  * Modular architecture suitable and separate optional components: **cron**, **syslog**, etc.
  * Expressive and flexible network handling (including VPN, bridges, etc.)
  * Verbose mode to debug service activity

===== Runlevels =====

OpenRC, as well as sysvinit and init (BSD), has a concept of task execution levels (i.e., [[https://en.wikipedia.org/wiki/Runlevel|runlevels]]). To define them in the conventional way, OpenRC uses names instead of numbers. This allows, for example, to have a default runlevel with "everything" enabled with a "powersaving" runlevel where some services are disabled.

The <color #0B71B9/#DDF1FF>rc-status</color> helper command will print all currently active runlevels and the state of services in them:

<code bash>
# rc-status
 * Caching service dependencies ... [ ok ]
Runlevel: default
 modules                     [  started  ]
 lvm                         [  started  ]
</code>

All runlevels are represented as folders in <color #0B71B9/#DDF1FF>/etc/runlevels/</color> with symbolic links to the actual service scripts.

Calling ''openrc'' with an argument (e.g., <color #0B71B9/#DDF1FF>openrc default</color>) will switch to that runlevel; this will start and stop services as needed.

Managing runlevels is usually done through the <color #0B71B9/#DDF1FF>rc-update</color> helper, but it could of course be done by hand if desired. For example, to add **nginx** to the ''default'' runlevel (with the need of root privileges): <color #0B71B9/#DDF1FF>rc-update add nginx default</color>

<note important>The command **''rc-update''** will not start nginx! You would still have to trigger rc, run the service script by hand, or start it with **''rc-service nginx start''**.</note>

The default startup uses the runlevels <color #0B71B9/#DDF1FF>sysinit</color>, <color #0B71B9/#DDF1FF>boot</color>, and <color #0B71B9/#DDF1FF>default</color>, in that order. Shutdown uses the <color #0B71B9/#DDF1FF>shutdown</color> runlevel. The defined runlevel <color #0B71B9/#DDF1FF>nonetwork</color> is used only for non-network services.

<note warning><color #620BB9/#EEDDFF>netctl</color> required systemd to work; therefore, it will not work anymore beginning with Milky Way v0.2, since OpenRC has become the main init system of Hyperbola. You should already have an alternative included with supported versions of Hyperbola; at present, it is [[https://www.hyperbola.info/packages/?q=netifrc|netifrc]].</note>

===== Groups =====

Users have to be manually added to some groups in order to be able to access the corresponding devices.
One problem is that you would not have any sound on your computer if you did not make sure that your user is in the <color #620BB9/#EEDDFF>audio</color> group, like so:

<code bash>
# usermod -aG audio <your-user>
</code>

Same as above for video: your games and other graphics output might be slow or lack acceleration without the below:

<code bash>
# usermod -aG video <your-user>
</code>

For networking:

<code bash>
# usermod -aG network <your-user>
</code>

For webcam:

<code bash>
# usermod -aG optical <your-user>
</code>

Also for storage:

<code bash>
# usermod -aG storage <your-user>
</code>

<code bash>
# usermod -aG disk <your-user>
</code>

And for CUPS:

<code bash>
# usermod -aG sys <your-user>
</code>

===== Migration =====

<note important> Be aware that since the release of version 0.4 we do not recommend any kind of migration from another system based onto Arch GNU/Linux. Since Hyperbola has included many changes and therefore differences it would be better to install the system from scratch with all changes you wish.</note>

===== Configuration =====

==== Services often required ====

Here with OpenRC, you might need to add services to support <color #620BB9/#EEDDFF>lvm2</color>, etc.

Here is the procedure for [[https://www.hyperbola.info/packages/?q=lvm2|lvm2]]:

<code bash>
# rc-update add lvm boot
</code>

For [[https://www.hyperbola.info/packages/?q=cryptsetup|cryptsetup]]:

<code bash>
# rc-update add dmcrypt boot
</code>

For [[https://www.hyperbola.info/packages/?q=alsa-utils|alsa-utils]]:

<code bash>
# rc-update add alsasound default
</code>

For [[https://www.hyperbola.info/packages/?q=cronie|cronie]]:

<code bash>
# rc-update add cronie default
</code>

On each package containing an OpenRC service, you will have this message:

<code bash>
      ==> rc 'rc-update add ... default'
</code>

==== Boot logs ====

Open the configuration file <color #0B71B9/#DDF1FF>/etc/rc.conf</color>, and uncomment the reference line <color #0B71B9/#DDF1FF>rc_logger="YES"</color>.\\
The log files for the entire **rc** process will be stored in <color #0B71B9/#DDF1FF>/var/log/rc.log</color>.

==== Hostname ====

OpenRC has its configuration files under the directory <color #0B71B9/#DDF1FF>/etc/conf.d/</color>.

In order to set your hostname, edit <color #0B71B9/#DDF1FF>/etc/conf.d/hostname</color>:

<code bash>
# nano /etc/conf.d/hostname
</code>

And redefine <color #0B71B9/#DDF1FF>localhost</color> with the name that you want. (Ideally, do not simply leave it as "localhost".)

<code>
# Set to the hostname of this machine
hostname="localhost"
</code>

==== Keyboard and Keymap ====

To modify the key map for use in the **console**: edit the file ''<color #0B71B9/#DDF1FF>/etc/conf.d/consolefont</color>''. See the full list of all the options available under ''<color #0B71B9/#DDF1FF>/usr/share/kbd/keymaps/</color>''. The below setting is just one example for US-English keyboard maps.

<code bash>
keymap="us"
</code>

To configure the keyboard for use with a **graphical interface**, edit the file ''<color #0B71B9/#DDF1FF>/etc/conf.d/keymaps</color>''. Again, the full list of options is available under ''<color #0B71B9/#DDF1FF>/usr/share/kbd/keymaps/</color>''. The following example is for US-English keyboard maps:

<code bash>
keymap="us"
</code>

After editing the files, run the command:

<code bash>
# rc-service keymaps restart
</code>

<note>This only applies for CLI. If you are using X11, this won't affect your graphical environment.</note>

==== Network settings ====

You need to enable the daemon <color #620BB9/#EEDDFF>dhcpcd</color> at runlevel default:

<code bash>
# rc-update add dhcpcd default
</code>



==== Login manager ====

**xorg-xdm**

To enable the login manager, edit <color #0B71B9/#DDF1FF>/etc/conf.d/xdm</color>.

If that file does not already exist, then first make sure to install the package **xorg-xdm**:
<code bash>
pacman -S xorg-xdm
</code>

As an example, to use **slim** as the graphical login manager (//with the precondition to install the package **slim**//), replace with the line:
<code bash>
DISPLAYMANAGER="slim"
</code>

In order for changes to take effect, make sure to enable the xdm daemon, like so:
<code bash>
# rc-update add xdm default
</code>

**slim**

The alternative would be to use **slim** direct. So first make sure to install the package **slim**:
<code bash>
pacman -S slim
</code>

You can add the service direct at the corresponding runlevel:
<code bash>
# rc-update add slim default
</code>

==== Kernel modules ====

For the automatic loading of any module of the <color #0BB928/#DDFFE3>Kernel Linux-Libre</color> edit the file <color #0B71B9/#DDF1FF>/etc/conf.d/modules</color>.

<code bash>
modules="module_name"
</code>

This is only necessary after installation of an application or driver, made by the system administrator, by default all native modules of <color #0BB928/#DDFFE3>Kernel Linux-Libre</color> are loaded automatically.


===== Adaptation between systemctl and rc-update =====

==== Add or delete a service ====

You can add a service using this way:

<code bash>
# rc-update add <service> <runlevel>
</code>

You also can delete a service as follows:

<code bash>
# rc-update del <service> <runlevel>
</code>

==== Services currently running ====

In order to have a summary of all the services running, stopped etc, you can run this command:

<code bash>
# rc-status --all -v
</code>

==== Stop / Start / Restart a service ====

To restart a service, you need to use <color #620BB9/#EEDDFF>rc-service</color>:

<code bash>
# rc-service <service> restart
</code>

===== Troubleshooting =====

==== Consistent network device naming is not disabled ====

To disable consistent network device naming, disable the assignment of fixed names, so that the unpredictable kernel names are used again, by masking <color #0BB928/#DDFFE3>udev</color>'s rule file for the default policy. This **“masking”** can be done by making a symbolic link to <color #0B71B9/#DDF1FF>/dev/null</color>. As root, issue a command as follows:

<code bash>
# ln -s /dev/null /lib/udev/rules.d/80-net-name-slot.rules
</code>

==== Sysctl.conf is missing ====

You can encounter an issue if <color #0B71B9/#DDF1FF>/etc/sysctl.conf</color> is missing. To fix this, you need to create the file:

<code bash>
# touch /etc/sysctl.conf
</code>

==== /usr/libexec/rc/cache doesn't exist ====

If you have this error when you shutdown the computer:

<code bash>
WARNING: /usr/libexec/rc/cache is not writable!
</code>

The solution is to create the folder:

<code bash>
# mkdir /usr/libexec/rc/cache
</code>

==== Swap isn't enabled ====

You need to manually add the swap partition in <color #0B71B9/#DDF1FF>/etc/fstab</color> as follows:

<code bash>
# /dev/sda2
UUID=0c3e9434-bc5c-461c-a5e4-4e9fe5f9a149	swap	swap	sw	0	0
</code>

==== tmpfs isn't present ====

Add it in <color #0B71B9/#DDF1FF>/etc/fstab</color>:

<code bash>
tmpfs		/tmp		tmpfs   nodev,nosuid          	0  	0
</code>

==== The system can't shutdown correctly ====

Please add your user to the group <color #620BB9/#EEDDFF>power</color>:

<code bash>
# usermod -aG power <your-user>
</code>

Afterwards you should be able to use the command as follows:

<code bash>
doas poweroff
</code>