Go to file
William Hubbs 110582491f service-script-guide.md cleanups
Refer to /var/run in the documentation instead of /run, and make it
clear at the top of the pidfile section that we use /run under Linux.

This is for #202.
2018-01-24 17:43:08 -06:00
bash-completion add bash completion support 2017-12-06 13:25:26 -06:00
conf.d strongly encourage Linux users to not make /etc/mtab a flat file 2017-11-14 15:41:03 -06:00
etc make the procedure for killing child processes of services configurable 2017-09-14 16:17:20 -05:00
init.d net-online: only process symbolic links in /sys/class/net 2018-01-05 14:56:33 -06:00
local.d local.d/README: typo fix 2016-08-15 13:47:06 -05:00
man rc-service: add --ifcrashed option 2017-12-04 17:17:17 -06:00
mk Add zsh-completion support 2017-12-07 11:30:32 -06:00
pkgconfig Revert "Make einfo routines private" 2013-10-21 13:49:41 -05:00
runlevels split cgroups mounting out of sysfs 2017-11-28 17:14:33 -06:00
scripts fix sysvinit compatibility for shutdown wrapper 2017-07-11 14:41:29 -05:00
sh Clean up the calls to group_add_service 2017-12-01 15:43:09 -06:00
src typo fix 2018-01-24 10:56:33 -06:00
support Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
sysctl.d sysctl.d: fix README 2012-02-10 09:17:22 -06:00
test test/setup_env: ensure that eval_ecolors is available on the path. 2017-01-31 17:27:13 -06:00
zsh-completion Add zsh-completion support 2017-12-07 11:30:32 -06:00
.gitignore dist: convert to tar.gz 2016-09-23 15:28:56 -05:00
agetty-guide.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
AUTHORS Convert OpenRC to a centralized copyright/license structure 2015-12-21 12:16:06 -06:00
BUSYBOX.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
ChangeLog Update ChangeLog 2017-10-24 10:42:11 -05:00
FEATURE-REMOVAL-SCHEDULE.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
HISTORY.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
LICENSE Convert OpenRC to a centralized copyright/license structure 2015-12-21 12:16:06 -06:00
Makefile Make bash-completion and zsh-completion optional 2017-12-07 12:53:04 -06:00
Makefile.inc version 0.35 2017-10-24 16:46:52 -05:00
NEWS.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
README.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
README.newnet Remove gentoo's net.* scripts 2013-08-13 16:33:41 -05:00
runit-guide.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
s6-guide.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
service-script-guide.md service-script-guide.md cleanups 2018-01-24 17:43:08 -06:00
STYLE-GUIDE.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
supervise-daemon-guide.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
TODO Add a potential future problem I can see with metric calculation and interfaces that change often. 2012-03-02 19:51:09 +00:00
user-guide.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00

OpenRC README

OpenRC is a dependency-based init system that works with the system-provided init program, normally /sbin/init. Currently, it does not have an init program of its own.

Installation

OpenRC requires GNU make.

Once you have GNU Make installed, the default OpenRC installation can be executed using this command:

make install

Configuration

You may wish to configure the installation by passing one or more of the below arguments to the make command

PROGLDFLAGS=-static
LIBNAME=lib64
DESTDIR=/tmp/openrc-image
MKBASHCOMP=no
MKNET=no
MKPAM=pam
MKPREFIX=yes
MKPKGCONFIG=no
MKSELINUX=yes
MKSTATICLIBS=no
MKSYSVINIT=yes
MKTERMCAP=ncurses
MKTERMCAP=termcap
MKZSHCOMP=no
PKG_PREFIX=/usr/pkg
LOCAL_PREFIX=/usr/local
PREFIX=/usr/local
BRANDING=\"Gentoo/$(uname -s)\"

Notes

We don't support building a static OpenRC with PAM.

You may need to use PROGLDFLAGS=-Wl,-Bstatic on glibc instead of just -static.

If you are building OpenRC for a Gentoo Prefix installation, add MKPREFIX=yes.

PKG_PREFIX should be set to where packages install to by default.

LOCAL_PREFIX should be set when to where user maintained packages are. Only set LOCAL_PREFIX if different from PKG_PREFIX.

PREFIX should be set when OpenRC is not installed to /.

If any of the following files exist then we do not overwrite them

/etc/devd.conf
/etc/rc
/etc/rc.shutdown
/etc/conf.d/*

rc and rc.shutdown are the hooks from the BSD init into OpenRC.

devd.conf is modified from FreeBSD to call /etc/rc.devd which is a generic hook into OpenRC.

inittab is the same, but for SysVInit as used by most Linux distributions. This can be found in the support folder.

Obviously, if you're installing this onto a system that does not use OpenRC by default then you may wish to backup the above listed files, remove them and then install so that the OS hooks into OpenRC.

Reporting Bugs

If you are using Gentoo Linux, bugs can be filed on their bugzilla under the gentoo hosted projects product and the openrc component [1]. Otherwise, you can report issues on our github [2].

Better yet, if you can contribute code, please feel free to submit pull requests [3].

IRC Channel

We have an official irc channel, #openrc on freenode, feel free to join us there.

[1] https://bugs.gentoo.org/ [2] https://github.com/openrc/openrc/issues [3] https://github.com/openrc/openrc/pulls