diff --git a/README.md b/README.md new file mode 100644 index 0000000..00995ff --- /dev/null +++ b/README.md @@ -0,0 +1,97 @@ +# initscripts +This repository contains source code for **legacy** *System V [initscripts](https://en.wikipedia.org/wiki/Init)*, +which are primarily used in *[Linux](https://en.wikipedia.org/wiki/Linux) distributions like e.g.*: +* [Fedora](https://en.wikipedia.org/wiki/Fedora_(operating_system)) +* [Red Hat Enterprise Linux](https://en.wikipedia.org/wiki/Red_Hat_Enterprise_Linux) +* [CentOS](https://en.wikipedia.org/wiki/CentOS) +* and some others as well... + +Since most of the major Linux distributions have already switched to +*[systemd](https://en.wikipedia.org/wiki/Systemd)*, the *initscripts concept* is +quite outdated nowadays. *As a result, this repository provides primarily only +the support for other initscripts that might still exist out there.* + +The above mentioned support includes e.g. the +[`/etc/rc.d/init.d/functions`](https://github.com/fedora-sysv/initscripts/blob/master/etc/rc.d/init.d/functions) +or +[`/usr/sbin/service`](https://github.com/fedora-sysv/initscripts/blob/master/usr/sbin/service) +files. + +Another functionality this source code provides includes: + * [`network-scripts`](https://github.com/fedora-sysv/initscripts/tree/master/network-scripts) - **legacy** scripts for manipulating of network devices + * [`readonly-root`](https://github.com/fedora-sysv/initscripts/blob/master/usr/lib/systemd/readonly-root) - service for configuring the read-only root support + * [`netconsole`](https://github.com/fedora-sysv/initscripts/blob/master/etc/rc.d/init.d/netconsole) - service for initializing of network console logging + +For the *[RPM](https://en.wikipedia.org/wiki/Rpm_(software))* based distributions +we also provide a [`specfile`](https://github.com/fedora-sysv/initscripts/blob/master/initscripts.spec) +for easier packaging. + +## Future of initscripts +As mentioned above, the *initscripts concept* is outdated nowadays, and de-facto +obsolete. Most of the work on this repository is just a maintenance, and we do +**not** plan on extending the support for initscripts in the future in any way. + +We intend to convert the rest of the remaining services into *systemd* units, +and remove them eventually if possible. + +And we have also started our work on decomissioning of +[`network-scripts`](https://github.com/fedora-sysv/initscripts/tree/master/network-scripts) +as well. This means no new functionality will be added into them. In case you +need some you should ask for it to be implemented +in *[NetworkManager](https://en.wikipedia.org/wiki/NetworkManager)*, if it isn't +already. + +## No longer active branches +Follow the steps in our wiki - +[how to access inactive branches](https://github.com/fedora-sysv/initscripts/wiki/How-to-access-inactive-branches) - +in case you need to check out old git branches for any reason. + + + +## Bugs reporting +If you find a bug, we would like to hear about it -- although we can't guarantee +we will be able to fix it... The best way to report bugs differs for each +distribution: + * `RHEL | CentOS` - create a bug report in [bugzilla](https://bugzilla.redhat.com/enter_bug.cgi) for corresponding RHEL version + * `Fedora | Other` - create a [new issue](https://github.com/fedora-sysv/initscripts/issues/new) directly here on GitHub + +**NOTE:** Bug reports created for *Fedora* in [bugzilla](https://bugzilla.redhat.com/) usually take a lot of time to +resolve. *We advise to use GitHub instead.*