Go to file
lishuxiang 8346c985d5 Update user-guide.md
fix a typo

This fixes #389.
2020-12-05 12:42:00 -06:00
bash-completion bash-completions/rc-service: allow tab to be used again 2018-12-27 16:31:15 -06:00
ci ci/travis.sh: run shellcheck on shell scripts 2019-10-28 18:42:10 -05:00
conf.d modules: remove the ability to rename modules on the fly 2018-06-29 15:29:46 -05:00
etc standardize the default shell 2018-12-08 12:06:26 -06:00
init.d Remove warning when osclock init.d script runs 2020-11-27 18:06:38 -06:00
local.d
man man/openrc.8: populate OPTIONS from --help output 2020-11-27 17:46:27 -06:00
mk combine test directories 2019-02-22 18:08:19 -06:00
pkgconfig
runlevels optimize loops for installing gettys 2019-08-15 18:40:51 -05:00
scripts scripts/shutdown.in: fix sysvinit compatible shutdown 2020-11-20 14:57:04 -06:00
sh binfmt: ensure a file is ungegistered before registering 2020-01-11 13:32:38 -06:00
src supervise-daemon: do not spawn a process if we are exiting 2020-11-29 21:22:43 -06:00
support update sysvinit support files 2019-08-20 13:08:44 -05:00
sysctl.d
test move ci scripts to their own directory 2019-02-22 18:50:13 -06:00
zsh-completion zsh-completion: _rc-service support extra actions 2019-01-21 17:41:59 -06:00
.cirrus.yml .cirrus.yml: Update FreeBSD releases 2020-04-19 13:15:35 +02:00
.gitignore
.travis.yml .travis.yml: install shellcheck 2019-10-28 16:48:40 -05:00
agetty-guide.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
AUTHORS Add Sony Interactive Entertainment as an author 2019-07-22 10:46:32 -05:00
BUSYBOX.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
ChangeLog Update ChangeLog 2019-08-20 13:09:50 -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
init-guide.md Delete stray text. 2020-01-11 11:15:56 -06:00
LICENSE
Makefile combine test directories 2019-02-22 18:08:19 -06:00
Makefile.inc version 0.42 2019-08-20 13:13:30 -05:00
NEWS.md update news for 0.43 with info on checkpath fix 2020-11-20 10:00:34 -06:00
README.md Fix typo in README 2020-01-11 12:16:19 -06:00
README.newnet
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: small cleanups 2018-06-05 17:26:57 -05:00
STYLE-GUIDE.md Reformat and fix titles in documentation 2018-01-12 14:10:42 -06:00
supervise-daemon-guide.md clarify supervise-daemon-guide 2019-07-26 12:52:52 -05:00
TODO
user-guide.md Update user-guide.md 2020-12-05 12:42:00 -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)\"
SH=/bin/sh

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 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