Compare commits

...
Sign in to create a new pull request.

5 commits

Author SHA1 Message Date
Carl George
614f07de6e Create getting started page 2024-05-02 02:23:43 -05:00
Carl George
fec09e7bd0 Create new homepage 2024-05-02 02:23:43 -05:00
Carl George
e2ab4ce2d8 Set up initial TOC 2024-05-02 02:23:43 -05:00
Carl George
aac2de40bc Sync standard files with docs template
https://gitlab.com/fedora/docs/templates/fedora-docs-template
2024-05-02 02:23:32 -05:00
Carl George
babc4f3959 Start docs overhaul
- Remove example files
- Move old sphinx docs to old.docs/2021/
- Move current antora docs to old.docs/2023/
2024-05-02 01:36:28 -05:00
51 changed files with 1061 additions and 559 deletions

10
.gitignore vendored
View file

@ -1,6 +1,4 @@
build/
cache/
node_modules/
public/
package-lock.json
package.json
/build/
/cache/
/public/
/preview.pid

436
LICENSE
View file

@ -1,10 +1,428 @@
The text of and illustrations in this document are licensed by Red Hat
under a Creative Commons Attribution–Share Alike 3.0 Unported license
("CC-BY-SA"). An explanation of CC-BY-SA is available at
http://creativecommons.org/licenses/by-sa/3.0/. In accordance with
CC-BY-SA, if you distribute this document or an adaptation of it, you
must provide the URL for the original version.
Attribution-ShareAlike 4.0 International
=======================================================================
Creative Commons Corporation ("Creative Commons") is not a law firm and
does not provide legal services or legal advice. Distribution of
Creative Commons public licenses does not create a lawyer-client or
other relationship. Creative Commons makes its licenses and related
information available on an "as-is" basis. Creative Commons gives no
warranties regarding its licenses, any material licensed under their
terms and conditions, or any related information. Creative Commons
disclaims all liability for damages resulting from their use to the
fullest extent possible.
Using Creative Commons Public Licenses
Creative Commons public licenses provide a standard set of terms and
conditions that creators and other rights holders may use to share
original works of authorship and other material subject to copyright
and certain other rights specified in the public license below. The
following considerations are for informational purposes only, are not
exhaustive, and do not form part of our licenses.
Considerations for licensors: Our public licenses are
intended for use by those authorized to give the public
permission to use material in ways otherwise restricted by
copyright and certain other rights. Our licenses are
irrevocable. Licensors should read and understand the terms
and conditions of the license they choose before applying it.
Licensors should also secure all rights necessary before
applying our licenses so that the public can reuse the
material as expected. Licensors should clearly mark any
material not subject to the license. This includes other CC-
licensed material, or material used under an exception or
limitation to copyright. More considerations for licensors:
wiki.creativecommons.org/Considerations_for_licensors
Considerations for the public: By using one of our public
licenses, a licensor grants the public permission to use the
licensed material under specified terms and conditions. If
the licensor's permission is not necessary for any reason--for
example, because of any applicable exception or limitation to
copyright--then that use is not regulated by the license. Our
licenses grant only permissions under copyright and certain
other rights that a licensor has authority to grant. Use of
the licensed material may still be restricted for other
reasons, including because others have copyright or other
rights in the material. A licensor may make special requests,
such as asking that all changes be marked or described.
Although not required by our licenses, you are encouraged to
respect those requests where reasonable. More considerations
for the public:
wiki.creativecommons.org/Considerations_for_licensees
=======================================================================
Creative Commons Attribution-ShareAlike 4.0 International Public
License
By exercising the Licensed Rights (defined below), You accept and agree
to be bound by the terms and conditions of this Creative Commons
Attribution-ShareAlike 4.0 International Public License ("Public
License"). To the extent this Public License may be interpreted as a
contract, You are granted the Licensed Rights in consideration of Your
acceptance of these terms and conditions, and the Licensor grants You
such rights in consideration of benefits the Licensor receives from
making the Licensed Material available under these terms and
conditions.
Section 1 -- Definitions.
a. Adapted Material means material subject to Copyright and Similar
Rights that is derived from or based upon the Licensed Material
and in which the Licensed Material is translated, altered,
arranged, transformed, or otherwise modified in a manner requiring
permission under the Copyright and Similar Rights held by the
Licensor. For purposes of this Public License, where the Licensed
Material is a musical work, performance, or sound recording,
Adapted Material is always produced where the Licensed Material is
synched in timed relation with a moving image.
b. Adapter's License means the license You apply to Your Copyright
and Similar Rights in Your contributions to Adapted Material in
accordance with the terms and conditions of this Public License.
c. BY-SA Compatible License means a license listed at
creativecommons.org/compatiblelicenses, approved by Creative
Commons as essentially the equivalent of this Public License.
d. Copyright and Similar Rights means copyright and/or similar rights
closely related to copyright including, without limitation,
performance, broadcast, sound recording, and Sui Generis Database
Rights, without regard to how the rights are labeled or
categorized. For purposes of this Public License, the rights
specified in Section 2(b)(1)-(2) are not Copyright and Similar
Rights.
e. Effective Technological Measures means those measures that, in the
absence of proper authority, may not be circumvented under laws
fulfilling obligations under Article 11 of the WIPO Copyright
Treaty adopted on December 20, 1996, and/or similar international
agreements.
f. Exceptions and Limitations means fair use, fair dealing, and/or
any other exception or limitation to Copyright and Similar Rights
that applies to Your use of the Licensed Material.
g. License Elements means the license attributes listed in the name
of a Creative Commons Public License. The License Elements of this
Public License are Attribution and ShareAlike.
h. Licensed Material means the artistic or literary work, database,
or other material to which the Licensor applied this Public
License.
i. Licensed Rights means the rights granted to You subject to the
terms and conditions of this Public License, which are limited to
all Copyright and Similar Rights that apply to Your use of the
Licensed Material and that the Licensor has authority to license.
j. Licensor means the individual(s) or entity(ies) granting rights
under this Public License.
k. Share means to provide material to the public by any means or
process that requires permission under the Licensed Rights, such
as reproduction, public display, public performance, distribution,
dissemination, communication, or importation, and to make material
available to the public including in ways that members of the
public may access the material from a place and at a time
individually chosen by them.
l. Sui Generis Database Rights means rights other than copyright
resulting from Directive 96/9/EC of the European Parliament and of
the Council of 11 March 1996 on the legal protection of databases,
as amended and/or succeeded, as well as other essentially
equivalent rights anywhere in the world.
m. You means the individual or entity exercising the Licensed Rights
under this Public License. Your has a corresponding meaning.
Section 2 -- Scope.
a. License grant.
1. Subject to the terms and conditions of this Public License,
the Licensor hereby grants You a worldwide, royalty-free,
non-sublicensable, non-exclusive, irrevocable license to
exercise the Licensed Rights in the Licensed Material to:
a. reproduce and Share the Licensed Material, in whole or
in part; and
b. produce, reproduce, and Share Adapted Material.
2. Exceptions and Limitations. For the avoidance of doubt, where
Exceptions and Limitations apply to Your use, this Public
License does not apply, and You do not need to comply with
its terms and conditions.
3. Term. The term of this Public License is specified in Section
6(a).
4. Media and formats; technical modifications allowed. The
Licensor authorizes You to exercise the Licensed Rights in
all media and formats whether now known or hereafter created,
and to make technical modifications necessary to do so. The
Licensor waives and/or agrees not to assert any right or
authority to forbid You from making technical modifications
necessary to exercise the Licensed Rights, including
technical modifications necessary to circumvent Effective
Technological Measures. For purposes of this Public License,
simply making modifications authorized by this Section 2(a)
(4) never produces Adapted Material.
5. Downstream recipients.
a. Offer from the Licensor -- Licensed Material. Every
recipient of the Licensed Material automatically
receives an offer from the Licensor to exercise the
Licensed Rights under the terms and conditions of this
Public License.
b. Additional offer from the Licensor -- Adapted Material.
Every recipient of Adapted Material from You
automatically receives an offer from the Licensor to
exercise the Licensed Rights in the Adapted Material
under the conditions of the Adapter's License You apply.
c. No downstream restrictions. You may not offer or impose
any additional or different terms or conditions on, or
apply any Effective Technological Measures to, the
Licensed Material if doing so restricts exercise of the
Licensed Rights by any recipient of the Licensed
Material.
6. No endorsement. Nothing in this Public License constitutes or
may be construed as permission to assert or imply that You
are, or that Your use of the Licensed Material is, connected
with, or sponsored, endorsed, or granted official status by,
the Licensor or others designated to receive attribution as
provided in Section 3(a)(1)(A)(i).
b. Other rights.
1. Moral rights, such as the right of integrity, are not
licensed under this Public License, nor are publicity,
privacy, and/or other similar personality rights; however, to
the extent possible, the Licensor waives and/or agrees not to
assert any such rights held by the Licensor to the limited
extent necessary to allow You to exercise the Licensed
Rights, but not otherwise.
2. Patent and trademark rights are not licensed under this
Public License.
3. To the extent possible, the Licensor waives any right to
collect royalties from You for the exercise of the Licensed
Rights, whether directly or through a collecting society
under any voluntary or waivable statutory or compulsory
licensing scheme. In all other cases the Licensor expressly
reserves any right to collect such royalties.
Section 3 -- License Conditions.
Your exercise of the Licensed Rights is expressly made subject to the
following conditions.
a. Attribution.
1. If You Share the Licensed Material (including in modified
form), You must:
a. retain the following if it is supplied by the Licensor
with the Licensed Material:
i. identification of the creator(s) of the Licensed
Material and any others designated to receive
attribution, in any reasonable manner requested by
the Licensor (including by pseudonym if
designated);
ii. a copyright notice;
iii. a notice that refers to this Public License;
iv. a notice that refers to the disclaimer of
warranties;
v. a URI or hyperlink to the Licensed Material to the
extent reasonably practicable;
b. indicate if You modified the Licensed Material and
retain an indication of any previous modifications; and
c. indicate the Licensed Material is licensed under this
Public License, and include the text of, or the URI or
hyperlink to, this Public License.
2. You may satisfy the conditions in Section 3(a)(1) in any
reasonable manner based on the medium, means, and context in
which You Share the Licensed Material. For example, it may be
reasonable to satisfy the conditions by providing a URI or
hyperlink to a resource that includes the required
information.
3. If requested by the Licensor, You must remove any of the
information required by Section 3(a)(1)(A) to the extent
reasonably practicable.
b. ShareAlike.
In addition to the conditions in Section 3(a), if You Share
Adapted Material You produce, the following conditions also apply.
1. The Adapter's License You apply must be a Creative Commons
license with the same License Elements, this version or
later, or a BY-SA Compatible License.
2. You must include the text of, or the URI or hyperlink to, the
Adapter's License You apply. You may satisfy this condition
in any reasonable manner based on the medium, means, and
context in which You Share Adapted Material.
3. You may not offer or impose any additional or different terms
or conditions on, or apply any Effective Technological
Measures to, Adapted Material that restrict exercise of the
rights granted under the Adapter's License You apply.
Section 4 -- Sui Generis Database Rights.
Where the Licensed Rights include Sui Generis Database Rights that
apply to Your use of the Licensed Material:
a. for the avoidance of doubt, Section 2(a)(1) grants You the right
to extract, reuse, reproduce, and Share all or a substantial
portion of the contents of the database;
b. if You include all or a substantial portion of the database
contents in a database in which You have Sui Generis Database
Rights, then the database in which You have Sui Generis Database
Rights (but not its individual contents) is Adapted Material,
including for purposes of Section 3(b); and
c. You must comply with the conditions in Section 3(a) if You Share
all or a substantial portion of the contents of the database.
For the avoidance of doubt, this Section 4 supplements and does not
replace Your obligations under this Public License where the Licensed
Rights include other Copyright and Similar Rights.
Section 5 -- Disclaimer of Warranties and Limitation of Liability.
a. UNLESS OTHERWISE SEPARATELY UNDERTAKEN BY THE LICENSOR, TO THE
EXTENT POSSIBLE, THE LICENSOR OFFERS THE LICENSED MATERIAL AS-IS
AND AS-AVAILABLE, AND MAKES NO REPRESENTATIONS OR WARRANTIES OF
ANY KIND CONCERNING THE LICENSED MATERIAL, WHETHER EXPRESS,
IMPLIED, STATUTORY, OR OTHER. THIS INCLUDES, WITHOUT LIMITATION,
WARRANTIES OF TITLE, MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE, NON-INFRINGEMENT, ABSENCE OF LATENT OR OTHER DEFECTS,
ACCURACY, OR THE PRESENCE OR ABSENCE OF ERRORS, WHETHER OR NOT
KNOWN OR DISCOVERABLE. WHERE DISCLAIMERS OF WARRANTIES ARE NOT
ALLOWED IN FULL OR IN PART, THIS DISCLAIMER MAY NOT APPLY TO YOU.
b. TO THE EXTENT POSSIBLE, IN NO EVENT WILL THE LICENSOR BE LIABLE
TO YOU ON ANY LEGAL THEORY (INCLUDING, WITHOUT LIMITATION,
NEGLIGENCE) OR OTHERWISE FOR ANY DIRECT, SPECIAL, INDIRECT,
INCIDENTAL, CONSEQUENTIAL, PUNITIVE, EXEMPLARY, OR OTHER LOSSES,
COSTS, EXPENSES, OR DAMAGES ARISING OUT OF THIS PUBLIC LICENSE OR
USE OF THE LICENSED MATERIAL, EVEN IF THE LICENSOR HAS BEEN
ADVISED OF THE POSSIBILITY OF SUCH LOSSES, COSTS, EXPENSES, OR
DAMAGES. WHERE A LIMITATION OF LIABILITY IS NOT ALLOWED IN FULL OR
IN PART, THIS LIMITATION MAY NOT APPLY TO YOU.
c. The disclaimer of warranties and limitation of liability provided
above shall be interpreted in a manner that, to the extent
possible, most closely approximates an absolute disclaimer and
waiver of all liability.
Section 6 -- Term and Termination.
a. This Public License applies for the term of the Copyright and
Similar Rights licensed here. However, if You fail to comply with
this Public License, then Your rights under this Public License
terminate automatically.
b. Where Your right to use the Licensed Material has terminated under
Section 6(a), it reinstates:
1. automatically as of the date the violation is cured, provided
it is cured within 30 days of Your discovery of the
violation; or
2. upon express reinstatement by the Licensor.
For the avoidance of doubt, this Section 6(b) does not affect any
right the Licensor may have to seek remedies for Your violations
of this Public License.
c. For the avoidance of doubt, the Licensor may also offer the
Licensed Material under separate terms or conditions or stop
distributing the Licensed Material at any time; however, doing so
will not terminate this Public License.
d. Sections 1, 5, 6, 7, and 8 survive termination of this Public
License.
Section 7 -- Other Terms and Conditions.
a. The Licensor shall not be bound by any additional or different
terms or conditions communicated by You unless expressly agreed.
b. Any arrangements, understandings, or agreements regarding the
Licensed Material not stated herein are separate from and
independent of the terms and conditions of this Public License.
Section 8 -- Interpretation.
a. For the avoidance of doubt, this Public License does not, and
shall not be interpreted to, reduce, limit, restrict, or impose
conditions on any use of the Licensed Material that could lawfully
be made without permission under this Public License.
b. To the extent possible, if any provision of this Public License is
deemed unenforceable, it shall be automatically reformed to the
minimum extent necessary to make it enforceable. If the provision
cannot be reformed, it shall be severed from this Public License
without affecting the enforceability of the remaining terms and
conditions.
c. No term or condition of this Public License will be waived and no
failure to comply consented to unless expressly agreed to by the
Licensor.
d. Nothing in this Public License constitutes or may be interpreted
as a limitation upon, or waiver of, any privileges and immunities
that apply to the Licensor or You, including from the legal
processes of any jurisdiction or authority.
=======================================================================
Creative Commons is not a party to its public
licenses. Notwithstanding, Creative Commons may elect to apply one of
its public licenses to material it publishes and in those instances
will be considered the “Licensor.” The text of the Creative Commons
public licenses is dedicated to the public domain under the CC0 Public
Domain Dedication. Except for the limited purpose of indicating that
material is shared under a Creative Commons public license or as
otherwise permitted by the Creative Commons policies published at
creativecommons.org/policies, Creative Commons does not authorize the
use of the trademark "Creative Commons" or any other trademark or logo
of Creative Commons without its prior written consent including,
without limitation, in connection with any unauthorized modifications
to any of its public licenses or any other arrangements,
understandings, or agreements concerning use of licensed material. For
the avoidance of doubt, this paragraph does not form part of the
public licenses.
Creative Commons may be contacted at creativecommons.org.
Red Hat, as the licensor of this document, waives the right to
enforce, and agrees not to assert, Section 4d of CC-BY-SA to the
fullest extent permitted by applicable law.

View file

@ -29,3 +29,7 @@ title to indicate to others that it is not ready to be merged yet.
[bugzilla]: https://bugzilla.redhat.com/
[releng]: https://pagure.io/releng/issues
[infra]: https://pagure.io/fedora-infrastructure/issues
## License
SPDX-License-Identifier: CC-BY-SA-4.0

View file

@ -1,6 +1,6 @@
# Name will be mostly visible in the URL. Treat it as an identifier.
# Tip: If you want to use the local preview scripts that come with this
# repository, please change this value in the site.yml file as well. (under
# repository, please change this value in the site.yml file as well (under
# site/start_page)
name: epel
@ -9,8 +9,8 @@ title: EPEL
# If you don't plan to have multiple versions of the docs (for example, to
# document multiple versions of some software), you can ignore this field.
# Otherwise, change "master" to a specific version.
version: master
# Otherwise, change "~" to a specific version.
version: ~
# We encourage you to name the index page as "index.adoc". If you absolutely
# have to use a different name, please reflect it here. You can ignore this

View file

@ -1,58 +0,0 @@
#!/bin/sh
image="docker.io/antora/antora"
cmd="--html-url-extension-style=indexify site.yml"
if uname | grep -iwq darwin; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo ""
echo "This build script is using Docker container runtime to run the build in an isolated environment."
echo ""
docker run --rm -it -v "$(pwd):/antora" "${image}" ${cmd}
elif uname | grep -iq linux; then
# Running on Linux.
# there isn't an antora/aarch64 container, antora can be installed locally
# Check whether podman is available, else fall back to docker
# which requires root.
if [ -x /usr/bin/npx ] && [ -f ./node_modules/.bin/antora ]; then
npx antora generate ${cmd}
elif [ -x /usr/local/bin/antora ]; then
/usr/local/bin/antora generate ${cmd}
elif uname -m | grep -iwq aarch64; then
# local install instructions from https://docs.antora.org/antora/latest/install/install-antora/
echo "no antora/aarch64 container; try just"
echo "\`node -e \"fs.writeFileSync('package.json', '{}')\"; npm i -D -E @antora/cli @antora/site-generator-default\`"
echo "or: \`npm install -g @antora/cli @antora/site-generator-default\`"
elif [ -f /usr/bin/podman ]; then
echo ""
echo "This build script is using Podman to run the build in an isolated environment."
echo ""
podman run --rm -it -v "$(pwd):/antora:z" "${image}" ${cmd}
elif [ -f /usr/bin/docker ]; then
echo ""
echo "This build script is using Docker to run the build in an isolated environment."
echo ""
if groups | grep -wq "docker"; then
docker run --rm -it -v "$(pwd):/antora:z" "${image}" ${cmd}
else
echo "You might be asked for your password."
echo "You can avoid this by adding your user to the 'docker' group,"
echo "but be aware of the security implications."
echo "See https://docs.docker.com/install/linux/linux-postinstall/"
echo ""
sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" ${cmd}
fi
else
echo ""
echo "Error: Container runtime haven't been found on your system. Fix it by:"
echo "$ sudo dnf install podman"
exit 1
fi
fi

292
docsbuilder.sh Executable file
View file

@ -0,0 +1,292 @@
#!/bin/bash
# script to watch source directory for changes, and re-run build and preview
#
# License: MIT
# https://fedoraproject.org/wiki/Licensing:MIT#Another_Minimal_variant_(found_in_libatomic_ops)
#
# Copyright (c) Fedora community contributors.
#
# THIS MATERIAL IS PROVIDED AS IS, WITH ABSOLUTELY NO WARRANTY EXPRESSED OR
# IMPLIED. ANY USE IS AT YOUR OWN RISK.
#
# Permission is hereby granted to use or copy this program for any purpose,
# provided the above notices are retained on all copies. Permission to modify
# the code and to distribute modified code is granted, provided the above
# notices are retained, and a notice that the code was modified is included
# with the above copyright notice.
script_name="docsbuilder.sh"
script_source="https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/raw/main/${script_name}"
version="1.2.0"
image="registry.gitlab.com/fedora/docs/docs-website/docs-fp-o:latest"
cmd="--html-url-extension-style=indexify site.yml"
srcdir="modules"
buildir="public"
previewpidfile="preview.pid"
# 4913: for vim users, vim creates a temporary file to test it can write to
# directory
# https://groups.google.com/g/vim_dev/c/sppdpElxY44
# .git: so we don't get rebuilds each time git metadata changes
inotifyignore="\.git.*|4913"
watch_and_build () {
if ! command -v inotifywait > /dev/null
then
echo "inotifywait command could not be found. Please install inotify-tools."
echo "On Fedora, run: sudo dnf install inotify-tools"
stop_preview_and_exit
else
# check for git
# required to get ignorelist
if ! command -v git > /dev/null
then
echo "git command could not be found. Please install git."
echo "On Fedora, run: sudo dnf install git-core"
stop_preview_and_exit
else
# Get files not being tracked, we don't watch for changes in these.
# Could hard code, but people use different editors that may create
# temporary files that are updated regularly and so on, so better
# to get the list from git. It'll also look at global gitingore
# settings and so on.
inotifyignore="$(git status -s --ignored | grep '^!!' | sed -e 's/^!! //' | tr '\n' '|')${inotifyignore}"
fi
while true
do
echo "Watching current directory (excluding: ${inotifyignore}) for changes and re-building as required. Use Ctrl C to stop."
inotifywait -q --exclude "($inotifyignore)" -e modify,create,delete,move -r . && echo "Change detected, rebuilding.." && build
done
fi
}
build () {
if [ "$(uname)" == "Darwin" ]; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo ""
echo "This build script is using Docker container runtime to run the build in an isolated environment."
echo ""
docker run --rm -it -v $(pwd):/antora $image $cmd
elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
# Running on Linux.
# Check whether podman is available, else faill back to docker
# which requires root.
if [ -n "$(command -v podman)" ]; then
echo ""
echo "This build script is using Podman to run the build in an isolated environment."
echo ""
podman run --rm -it -v $(pwd):/antora:z $image $cmd --stacktrace
elif [ -n "$(command -v docker)" ]; then
echo ""
echo "This build script is using Docker to run the build in an isolated environment."
echo ""
if groups | grep -wq "docker"; then
docker run --rm -it -v $(pwd):/antora:z $image $cmd
else
echo ""
echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password."
echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/."
echo ""
sudo docker run --rm -it -v $(pwd):/antora:z $image $cmd
fi
else
echo ""
echo "Error: Container runtime haven't been found on your system. Fix it by:"
echo "$ sudo dnf install podman"
exit 1
fi
fi
}
start_preview () {
# clean up a preview that may be running
stop_preview
# always run an initial build so preview shows latest version
build
if [ "$(uname)" == "Darwin" ]; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo "The preview will be available at http://localhost:8080/"
docker run --rm -v $(pwd):/antora:ro -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro -p 8080:80 nginx
elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then
# Running on Linux.
# Fedora Workstation has python3 installed as a default, so using that
echo ""
echo "The preview is available at http://localhost:8080"
echo ""
pushd "${buildir}" > /dev/null 2>&1
python3 -m http.server 8080 &
echo "$!" > ../"${previewpidfile}"
popd > /dev/null 2>&1
fi
}
stop_preview () {
if [ -e "${previewpidfile}" ]
then
PID=$(cat "${previewpidfile}")
kill $PID
echo "Stopping preview server (running with PID ${PID}).."
rm -f "${previewpidfile}"
else
echo "No running preview server found to stop: no ${previewpidfile} file found."
fi
}
stop_preview_and_exit ()
{
# stop and also exit the script
# if stop_preview is trapped, then SIGINT doesn't stop the build loop. So
# we need to make sure we also exit the script.
# stop_preview is called before other functions, so we cannot add exit to
# it.
stop_preview
exit 0
}
# https://apple.stackexchange.com/questions/83939/compare-multi-digit-version-numbers-in-bash/123408#123408
version () { echo "$@" | awk -F. '{ printf("%d%03d%03d%03d\n", $1,$2,$3,$4); }'; }
check_update () {
if ! command -v curl > /dev/null
then
echo "curl command could not be found. Please install curl."
echo "On Fedora, run: sudo dnf install curl"
exit 0
fi
script_version="$(grep "^version=" ${script_name} | cut -d '=' -f2 | tr --delete '"')"
tempdir="$(mktemp -d)"
echo "$tempdir"
pushd "$tempdir" > /dev/null 2>&1
curl "$script_source" --silent --output "${script_name}"
upstream_version="$(grep "^version=" ${script_name} | cut -d '=' -f2 | tr --delete '"')"
echo "${upstream_version}"
if [ $(version $upstream_version) -gt $(version $script_version) ]; then
echo "Update available"
echo "Script version $upstream_version is available at $script_source"
echo "This version is $script_version."
echo "Please use the '-U' option to update."
echo
fi
popd > /dev/null 2&>1
}
install_update () {
if ! command -v curl > /dev/null
then
echo "curl command could not be found. Please install curl."
echo "On Fedora, run: sudo dnf install curl"
exit 0
fi
curl "$script_source" --silent --output "${script_name}.new"
mv "${script_name}.new" "${script_name}"
chmod +x "${script_name}"
}
usage() {
echo "$0: Build and preview Fedora antora based documentation"
echo
echo "Usage: $0 [-awbpkh]"
echo
echo "-a: start preview, start watcher and rebuilder"
echo "-w: start watcher and rebuilder"
echo "-b: rebuild"
echo "-p: start_preview"
echo "-k: stop_preview"
echo "-h: print this usage text and exit"
echo "-u: check builder script update"
echo "-U: install builder script from upstream"
echo
echo "Maintained by the Fedora documentation team."
echo "Please contact on our channels: https://docs.fedoraproject.org/en-US/fedora-docs/#find-docs"
}
# check if the script is being run in a Fedora docs repository
if [ ! -e "site.yml" ]
then
echo "site.yml not be found."
echo "This does not appear to be a Fedora Antora based documentation repository."
echo "Exiting."
echo
usage
exit 1
fi
if [ $# -lt 1 ]
then
echo "No options provided, running preview with watch and build."
echo "Run script with '-h' to see all available options."
echo
echo
trap stop_preview_and_exit INT
start_preview
watch_and_build
stop_preview
fi
# parse options
while getopts "awbpkhuU" OPTION
do
case $OPTION in
a)
# handle sig INT to stop the preview
trap stop_preview_and_exit INT
start_preview
watch_and_build
stop_preview
exit 0
;;
w)
watch_and_build
exit 0
;;
b)
build
exit 0
;;
p)
start_preview
echo "Please run ./${script_name} -k to stop the preview server"
exit 0
;;
k)
stop_preview
exit 0
;;
h)
usage
exit 0
;;
u)
check_update
exit 0
;;
U)
install_update
exit 0
;;
?)
usage
exit 1
;;
esac
done

View file

@ -2,32 +2,17 @@
<!-- Created with Inkscape (http://www.inkscape.org/) -->
<svg
xmlns:dc="http://purl.org/dc/elements/1.1/"
xmlns:cc="http://creativecommons.org/ns#"
xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"
xmlns:svg="http://www.w3.org/2000/svg"
xmlns="http://www.w3.org/2000/svg"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
width="79.375mm"
height="105.83334mm"
viewBox="0 0 79.375 105.83334"
width="43.001732mm"
height="50.886917mm"
viewBox="0 0 43.001732 50.886917"
version="1.1"
id="svg2794"
inkscape:version="0.92.3 (2405546, 2018-03-11)"
sodipodi:docname="epel-logo-4.wbackground.svg">
<metadata
id="metadata17">
<rdf:RDF>
<cc:Work
rdf:about="">
<dc:format>image/svg+xml</dc:format>
<dc:type
rdf:resource="http://purl.org/dc/dcmitype/StillImage" />
<dc:title></dc:title>
</cc:Work>
</rdf:RDF>
</metadata>
inkscape:version="1.1 (c68e22c387, 2021-05-23)"
sodipodi:docname="rotate-04_aug2021.svg"
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
xmlns="http://www.w3.org/2000/svg"
xmlns:svg="http://www.w3.org/2000/svg">
<sodipodi:namedview
id="namedview2796"
pagecolor="#ffffff"
@ -39,112 +24,72 @@
inkscape:document-units="mm"
showgrid="false"
lock-margins="true"
fit-margin-top="0"
fit-margin-left="0"
fit-margin-right="0"
fit-margin-bottom="0"
fit-margin-top="10"
fit-margin-left="10"
fit-margin-right="10"
fit-margin-bottom="10"
inkscape:zoom="0.95499439"
inkscape:cx="263.08967"
inkscape:cy="202.09427"
inkscape:window-width="1441"
inkscape:window-height="745"
inkscape:window-x="2145"
inkscape:window-y="88"
inkscape:window-maximized="0"
inkscape:current-layer="layer1"
inkscape:snap-nodes="false"
inkscape:snap-global="false" />
inkscape:cx="-98.953461"
inkscape:cy="241.88624"
inkscape:window-width="2560"
inkscape:window-height="1374"
inkscape:window-x="0"
inkscape:window-y="0"
inkscape:window-maximized="1"
inkscape:current-layer="layer1" />
<defs
id="defs2791" />
<g
inkscape:groupmode="layer"
id="layer2"
inkscape:label="background"
transform="translate(142.77219,27.923905)" />
<g
inkscape:label="Layer 1"
inkscape:groupmode="layer"
id="layer1"
transform="translate(11.617268,-55.791218)">
transform="translate(-131.15492,-83.715123)">
<g
id="g932"
transform="translate(53.19403,0.27705257)">
transform="matrix(0.26458333,0,0,0.26458333,200.40036,-167.46327)"
id="g56815"
style="display:inline">
<g
transform="translate(18.671711,82.883966)"
id="g912">
<rect
style="fill:#dfdfdf;fill-opacity:1;stroke:none;stroke-width:5.29166651;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1"
id="rect891"
width="79.375"
height="105.83334"
x="-83.483009"
y="-27.369801"
ry="5.6719646" />
<rect
ry="5.2017727"
y="-22.983147"
x="-80.193016"
height="97.060036"
width="72.795013"
id="rect908"
style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:4.85300064;stroke-miterlimit:4;stroke-dasharray:none;stroke-opacity:1" />
</g>
<g
transform="matrix(1.9956578,0,0,1.9956578,-329.77171,-109.41234)"
id="g843">
id="g56813"
transform="translate(15.434597,40)">
<g
transform="matrix(0.26458333,0,0,0.26458333,200.40036,-167.46327)"
id="g56815"
style="display:inline">
<g
id="g56813"
transform="translate(15.434597,40)">
<g
aria-label="EPEL"
id="text56811"
style="font-size:18.18989944px;line-height:0%;letter-spacing:0px;word-spacing:0px;fill:#294172;stroke-width:1.06666994">
<path
d="m -228.70596,1059.1423 v -3.9544 h 9.60776 v -4.5721 h -9.60776 v -3.6454 h 10.90527 v -4.7267 h -16.96032 v 21.6252 h 17.36193 v -4.7266 z"
style="font-weight:800;font-size:30.89310074px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3016"
inkscape:connector-curvature="0" />
<path
d="m -204.11508,1042.2437 h -9.88579 v 21.6252 h 6.11683 v -5.6534 h 3.76896 c 5.90058,0 9.60775,-3.0585 9.60775,-7.9705 0,-4.9429 -3.70717,-8.0013 -9.60775,-8.0013 z m -0.37072,11.1524 h -3.39824 v -6.3331 h 3.39824 c 2.53324,0 3.79985,1.174 3.79985,3.182 0,1.9772 -1.26661,3.1511 -3.79985,3.1511 z"
style="font-weight:800;font-size:30.89310074px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3018"
inkscape:connector-curvature="0" />
<path
d="m -185.48656,1059.1423 v -3.9544 h 9.60775 v -4.5721 h -9.60775 v -3.6454 h 10.90526 v -4.7267 h -16.96031 v 21.6252 h 17.36192 v -4.7266 z"
style="font-weight:800;font-size:30.89310074px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3020"
inkscape:connector-curvature="0" />
<path
d="m -170.78148,1063.8689 h 16.43513 v -4.8502 h -10.3183 v -16.775 h -6.11683 z"
style="font-weight:800;font-size:30.89310074px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3022"
inkscape:connector-curvature="0" />
</g>
</g>
</g>
<g
id="g830">
aria-label="EPEL"
id="text56811"
style="font-size:18.1899px;line-height:0%;letter-spacing:0px;word-spacing:0px;fill:#294172;stroke-width:1.06667">
<path
id="path57241"
style="fill:#51a2da;fill-opacity:1;stroke:none;stroke-width:0.89758563"
d="m 149.44371,93.715204 c -0.741,0 -1.33773,0.596709 -1.33773,1.337694 v 1.337704 c 0,0.741003 0.59673,1.33677 1.33773,1.336779 h 1.21522 v 0.769034 c 0,0.219171 0.21735,0.397106 0.49632,0.41653 0.0166,8.88e-4 0.0335,0.0027 0.0505,0.0027 0.002,2.6e-5 0.004,0 0.005,0 h 2.49033 c 0.002,0 0.004,2.6e-5 0.005,0 0.30282,1.8e-5 0.54688,-0.186589 0.54688,-0.418837 V 97.7273 h 8.56518 c 0.741,0 1.33768,-0.595785 1.33771,-1.336779 v -1.337703 c 0,-0.740977 -0.59671,-1.337695 -1.33771,-1.337695 z"
inkscape:connector-curvature="0" />
d="m -228.70596,1059.1423 v -3.9544 h 9.60776 v -4.5721 h -9.60776 v -3.6454 h 10.90527 v -4.7267 h -16.96032 v 21.6252 h 17.36193 v -4.7266 z"
style="font-weight:800;font-size:30.8931px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3016" />
<path
id="path57243"
style="fill:#51a2da;fill-opacity:1;stroke:none;stroke-width:0.89758676"
d="m 149.17187,100.09573 c -0.741,1e-5 -1.3377,0.59671 -1.3377,1.33771 v 2.99591 c 0,0.74099 0.5967,1.3377 1.3377,1.3377 h 0.45457 v 0.0134 h 1.03063 v 0.77786 c 0,0.21918 0.21737,0.39707 0.49632,0.41652 0.0166,9.5e-4 0.0335,0.002 0.0506,0.002 h 0.005 2.49035 0.005 c 0.30281,0 0.54685,-0.18659 0.54685,-0.41885 v -0.77785 h 1.03066 v -0.0139 h 0.44343 c 0.741,0 1.33677,-0.59625 1.33677,-1.33724 v -2.99545 c 0,-0.74102 -0.59573,-1.33822 -1.33677,-1.33816 h -1.47221 v 0.77599 c 0,0.23225 -0.24406,0.41886 -0.54688,0.41885 -0.002,2e-5 -0.004,0 -0.005,0 h -2.49033 c -0.002,0 -0.003,2e-5 -0.005,0 -0.0171,0 -0.034,-0.002 -0.0506,-0.003 -0.27897,-0.0194 -0.49632,-0.19736 -0.49632,-0.41653 v -0.77553 z"
inkscape:connector-curvature="0" />
d="m -204.11508,1042.2437 h -9.88579 v 21.6252 h 6.11683 v -5.6534 h 3.76896 c 5.90058,0 9.60775,-3.0585 9.60775,-7.9705 0,-4.9429 -3.70717,-8.0013 -9.60775,-8.0013 z m -0.37072,11.1524 h -3.39824 v -6.3331 h 3.39824 c 2.53324,0 3.79985,1.174 3.79985,3.182 0,1.9772 -1.26661,3.1511 -3.79985,3.1511 z"
style="font-weight:800;font-size:30.8931px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3018" />
<path
id="path57245"
style="fill:#db3279;fill-opacity:1;stroke:none;stroke-width:0.89758563"
d="m 142.49261,108.25437 c -0.74099,0 -1.33769,0.59671 -1.33769,1.33771 v 1.33769 c 0,0.74101 0.5967,1.33677 1.33769,1.33678 h 13.37517 c 0.74099,-10e-6 1.33769,-0.59578 1.33769,-1.33677 v -1.33771 c 0,-0.74098 -0.5967,-1.33769 -1.33769,-1.3377 l -0.58538,1e-5 v 0.005 h -1.03064 v 0.77785 c 1e-5,0.23225 -0.24403,0.41885 -0.54684,0.41884 -9e-4,0 -0.004,0 -0.005,0 h -2.49033 c -8.9e-4,0 -0.004,0 -0.005,0 -0.017,0 -0.0339,-0.002 -0.0505,-0.003 -0.27898,-0.0194 -0.4963,-0.19735 -0.49627,-0.41655 v -0.77785 h -1.03065 v -0.004 z"
inkscape:connector-curvature="0" />
d="m -185.48656,1059.1423 v -3.9544 h 9.60775 v -4.5721 h -9.60775 v -3.6454 h 10.90526 v -4.7267 h -16.96031 v 21.6252 h 17.36192 v -4.7266 z"
style="font-weight:800;font-size:30.8931px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3020" />
<path
d="m -170.78148,1063.8689 h 16.43513 v -4.8502 h -10.3183 v -16.775 h -6.11683 z"
style="font-weight:800;font-size:30.8931px;line-height:125%;font-family:Montserrat;-inkscape-font-specification:'Montserrat Ultra-Bold'"
id="path3022" />
</g>
</g>
</g>
<g
id="g57247"
transform="matrix(0.89757667,0,0,0.89757667,-84.85899,267.41653)">
<path
id="path57241"
style="fill:#51a2da;fill-opacity:1;stroke:none;stroke-width:1.00001"
d="m 261.0392,-193.52255 c -0.82555,0 -1.49037,0.6648 -1.49037,1.49034 v 1.49035 c 0,0.82556 0.66482,1.48931 1.49037,1.48932 h 1.3539 v 0.85679 c 0,0.24418 0.24215,0.44242 0.55295,0.46406 0.0185,9.9e-4 0.0373,0.003 0.0563,0.003 0.002,3e-5 0.004,0 0.006,0 h 2.7745 c 0.002,0 0.004,3e-5 0.006,0 0.33737,2e-5 0.60928,-0.20788 0.60928,-0.46663 v -0.85731 h 9.54257 c 0.82555,0 1.49032,-0.66377 1.49035,-1.48932 v -1.49035 c 0,-0.82553 -0.6648,-1.49034 -1.49035,-1.49034 z" />
<path
id="path57243"
style="fill:#51a2da;fill-opacity:1;stroke:none;stroke-width:3.77957"
d="m 1407.3574,-951.09766 c -3.1202,4e-5 -5.6328,2.51263 -5.6328,5.63282 v 12.61523 c 0,3.12015 2.5126,5.63281 5.6328,5.63281 h 1.9141 v 0.0566 h 4.3398 v 3.27539 c 0,0.92293 0.9153,1.67201 2.0899,1.75391 0.07,0.004 0.1411,0.01 0.2129,0.01 h 0.021 10.4864 0.023 c 1.2751,3e-5 2.3027,-0.78569 2.3027,-1.76368 v -3.27539 h 4.3399 v -0.0586 h 1.8672 c 3.1202,0 5.6289,-2.51071 5.6289,-5.63086 v -12.61328 c 0,-3.1203 -2.5085,-5.63503 -5.6289,-5.63477 h -6.1992 v 3.26758 c 0,0.97795 -1.0277,1.76371 -2.3028,1.76367 -0.01,8e-5 -0.016,0 -0.023,0 h -10.4863 c -0.01,0 -0.014,8e-5 -0.022,0 -0.072,0 -0.143,-0.008 -0.2129,-0.0117 -1.1747,-0.0818 -2.0899,-0.83103 -2.0899,-1.75391 v -3.26563 z"
transform="matrix(0.26458333,0,0,0.26458333,-111.62695,65.230656)" />
<path
id="path57245"
style="fill:#db3279;fill-opacity:1;stroke:none;stroke-width:1.00001"
d="m 253.29491,-177.32431 c -0.82555,0 -1.49034,0.66481 -1.49034,1.49036 v 1.49034 c 0,0.82556 0.66479,1.48931 1.49034,1.48932 h 14.90142 c 0.82555,-1e-5 1.49034,-0.66377 1.49034,-1.48931 v -1.49036 c 0,-0.82553 -0.66479,-1.49034 -1.49034,-1.49035 l -0.65218,1e-5 v 0.006 h -1.14824 v 0.86661 c 10e-6,0.25875 -0.27188,0.46665 -0.60925,0.46664 -10e-4,0 -0.004,0 -0.006,0 h -2.7745 c -0.001,0 -0.004,0 -0.006,0 -0.0189,0 -0.0378,-0.002 -0.0563,-0.003 -0.31082,-0.0216 -0.55294,-0.21987 -0.5529,-0.46409 v -0.86661 h -1.14826 v -0.004 z" />
</g>
</g>
</svg>

Before

Width:  |  Height:  |  Size: 7.4 KiB

After

Width:  |  Height:  |  Size: 5.5 KiB

Before After
Before After

Binary file not shown.

Before

Width:  |  Height:  |  Size: 220 KiB

View file

@ -1,9 +0,0 @@
This is an example of a example file. Unlike files in `pages/`, files in this directory are not built as standalone pages, but only if they are included in a file within `pages/`. Also unlike examples,
A file in this directory can be included within any file in the `pages/` directory.
Most common use cases for examples is using output from an external script (for example, translation string statistics) in docs. You can use an external script to update the example, and when the site is rebuilt, it will show updated output.
If you want to include this particular example somewhere, you can use the following syntax: `include::example$example-example.adoc[]`.
Note the use of `example$` instead of an actual file location.
See link:https://docs.antora.org/antora/3.0/examples-directory/[Antora docs on examples] for more information about partials.

View file

@ -1,22 +1,12 @@
* xref:epel-about.adoc[About]
** xref:epel-about-history-philosophy.adoc[History and Philosophy]
** xref:epel-about-next.adoc[EPEL-Next]
** xref:epel-about-playground.adoc[EPEL-Playground]
* xref:epel-policy.adoc[Guidelines and Policies]
** xref:epel-policy-updates.adoc[Updates]
** xref:epel-policy-incompatible-upgrades.adoc[Incompatible Upgrades]
** xref:epel-policy-retirement.adoc[Package Retirement]
** xref:epel-policy-scl.adoc[Software Collections (SCL)]
** xref:epel-policy-missing-sub-packages.adoc[Missing RHEL Sub-Packages]
** xref:epel-policy-steering-committee.adoc[Steering Committee]
* xref:epel-help.adoc[Helping EPEL]
** xref:epel-qa.adoc[EPEL QA]
** xref:epel-packaging.adoc[Packaging]
** xref:epel-packaging-examples.adoc[Packaging Examples]
** xref:epel-package-maintainers.adoc[Package Maintainers]
** xref:epel-package-maintainer-generic-description.adoc[EPEL Package Maintainer Generic Description]
** xref:epel-rhel-entitlements.adoc[RHEL Entitlements]
** xref:epel-packagers-sig.adoc[EPEL Packagers SIG]
** xref:fedora-package-in-epel.adoc[Get Fedora Package in EPEL]
* xref:epel-package-request.adoc[Request Packages]
* xref:epel-faq.adoc[FAQ]
* xref:getting-started.adoc[Getting Started]
* Available Packages
* Request Package
* Policy
* Contributor Guide
** Packaging Guidelines
** Packaging Workflows
** Incompatible Updates
** Package Retirement
** Stalled Package Request
* FAQ
* Contact Us

View file

@ -0,0 +1,71 @@
= Getting Started
CAUTION: Some EPEL packages depend on packages from repositories that are not enabled by default.
Take note of the additional repositories being enabled in the instructions on this page.
NOTE: For convenience,
some distributions include copies of EPEL release packages in their default repositories,
allowing you to install them by name without the full URL.
The EPEL project recommends using the URLs to the official packages to ensure the best experience.
== EL9
EPEL 9 officially targets RHEL 9 and CentOS Stream 9.
If you are using RHEL 9, install `epel-release`.
If you are using CentOS Stream 9, install *both* `epel-release` and `epel-next-release`.
* https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm[epel-release-latest-9]
* https://dl.fedoraproject.org/pub/epel/epel-next-release-latest-9.noarch.rpm[epel-next-release-latest-9]
=== CentOS Stream 9
----
dnf config-manager --set-enabled crb
dnf install https://dl.fedoraproject.org/pub/epel/epel{,-next}-release-latest-9.noarch.rpm
----
=== RHEL 9
----
subscription-manager repos --enable codeready-builder-for-rhel-9-$(arch)-rpms
dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
----
=== Other RHEL 9 compatible distributions
EPEL 9 packages will also likely work with distributions that target RHEL 9 compatibility.
We cannot list specific instructions for all such distributions,
but in general the steps will look similar to the steps for RHEL 9.
First enable the distribution's equivalent of the CRB repository,
then install the https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm[epel-release-latest-9] package.
== EL8
We offer the following release packages for the EL8 family.
If you are using RHEL or a RHEL derivative, install `epel-release`.
If you are using CentOS Stream, install *both* `epel-release` and `epel-next-release`.
* https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm[epel-release-latest-8]
* https://dl.fedoraproject.org/pub/epel/epel-next-release-latest-8.noarch.rpm[epel-next-release-latest-8]
=== CentOS Stream 8
----
dnf config-manager --set-enabled powertools
dnf install https://dl.fedoraproject.org/pub/epel/epel{,-next}-release-latest-8.noarch.rpm
----
=== RHEL 8
----
subscription-manager repos --enable codeready-builder-for-rhel-8-$(arch)-rpms
dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
----
=== Other RHEL 8 compatible distributions
EPEL 8 packages will also likely work with distributions that target RHEL 8 compatibility.
We cannot list specific instructions for all such distributions,
but in general the steps will look similar to the steps for RHEL 8.
First enable the distribution's equivalent of the CRB (or PowerTools) repository,
then install the https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm[epel-release-latest-8] package.

View file

@ -1,304 +1,21 @@
include::partial$attributes.adoc[]
= Extra Packages for Enterprise Linux (EPEL)
= Extra Packages for Enterprise Linux
image::epel-logo.svg[EPEL]
:fedora: https://fedoraproject.org/
:centos: https://centos.org/
:rhel: https://redhat.com/rhel
[[extra_packages_for_enterprise_linux_epel]]
image::epel-logo.svg[EPEL logo,350]
Welcome to the home of the EPEL Special Interest Group.
Extra Packages for Enterprise Linux (EPEL) is an initiative within the {fedora}[Fedora Project]
to provide high quality additional packages for {centos}[CentOS Stream] and {rhel}[Red Hat Enterprise Linux] (RHEL).
The goal for EPEL packages is to enhance these distributions,
without disturbing or replacing packages from the default repositories.
EPEL packages should, when possible,
be maintained in similar ways to packages from the default repositories.
The goal of EPEL is to make high quality Fedora packages available for RHEL and compatible derivatives.
EPEL is governed by the EPEL Steering Committee.
All Fedora maintainers who build for EPEL are part of the initiative.
Some of these maintainers collaborate in the EPEL Packagers Special Interest Group.
== Quickstart
We offer release packages containing our repository configuration files and public package signing keys.
Use the version that corresponds to the major version of your operating system.
* https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm[epel-release-latest-9]
* https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm[epel-release-latest-8]
* https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm[epel-release-latest-7]
If you are using CentOS Stream, we also recommend installing the corresponding epel-next-release package.
* https://dl.fedoraproject.org/pub/epel/epel-next-release-latest-9.noarch.rpm[epel-next-release-latest-9]
* https://dl.fedoraproject.org/pub/epel/epel-next-release-latest-8.noarch.rpm[epel-next-release-latest-8]
For convenience some distributions include these release packages in their default repositories,
allowing you to install them by name without the full URL.
Some EPEL packages depend on packages from repositories that are not enabled by default.
Take note of the additional repositories being enabled in the following instructions.
=== EL9
==== CentOS Stream 9
....
dnf config-manager --set-enabled crb
dnf install epel-release epel-next-release
....
==== RHEL 9
....
subscription-manager repos --enable codeready-builder-for-rhel-9-$(arch)-rpms
dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
....
==== AlmaLinux 9, Rocky Linux 9
....
dnf config-manager --set-enabled crb
dnf install epel-release
....
=== EL8
==== CentOS Stream 8
....
dnf config-manager --set-enabled powertools
dnf install epel-release epel-next-release
....
==== RHEL 8
....
subscription-manager repos --enable codeready-builder-for-rhel-8-$(arch)-rpms
dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-8.noarch.rpm
....
==== AlmaLinux 8, Rocky Linux 8
....
dnf config-manager --set-enabled powertools
dnf install epel-release
....
=== EL7
==== RHEL 7
....
subscription-manager repos --enable rhel-*-optional-rpms \
--enable rhel-*-extras-rpms \
--enable rhel-ha-for-rhel-*-server-rpms
yum install https://dl.fedoraproject.org/pub/epel/epel-release-latest-7.noarch.rpm
....
==== CentOS 7
....
yum install epel-release
....
[[what_is_extra_packages_for_enterprise_linux_or_epel]]
== What is Extra Packages for Enterprise Linux (or EPEL)?
Extra Packages for Enterprise Linux (or EPEL) is a Fedora Special
Interest Group that creates, maintains, and manages a high quality set
of additional packages for Enterprise Linux, including, but not limited
to, https://docs.fedoraproject.org/en-US/quick-docs/fedora-and-red-hat-enterprise-linux/index.html[Red Hat Enterprise Linux] (RHEL),
CentOS, Scientific Linux (SL), Oracle Linux (OL), AlmaLinux (AL) and Rocky Linux (RL).
EPEL packages are usually based on their Fedora counterparts
and should not conflict with or replace packages in the base Enterprise Linux distributions.
EPEL uses much of the same infrastructure as Fedora,
including buildsystem, Bugzilla instance, updates manager, mirror manager and more.
Learn more about EPEL in the following pages:
* link:epel-faq[EPEL FAQ]
* link:epel-about[About EPEL]
* link:epel-policy[EPEL Guidelines and Policies]
[[what_is_epel_next]]
== What is EPEL-Next?
EPEL packages are built against RHEL. EPEL Next packages are built against CentOS Stream.
EPEL-Next is not a complete rebuild of all the EPEL packages, but only those packages that need to be rebuilt to install on CentOS Stream. The EPEL-Next repo is meant to be layered on top of the regular EPEL repository.
Learn more about EPEL-Next on the following page:
* link:epel-about-next[EPEL Next]
[[what_packages_and_versions_are_available_in_epel]]
== What packages and versions are available in EPEL?
Since EPEL is part of the Fedora project, you can search the available packages in the
https://packages.fedoraproject.org/[Fedora Packages web app].
This provides an overview of available versions across various EPEL branches.
If you find a package that is not yet available in the EPEL branch you would like it to be,
please follow xref:epel-package-request.adoc[this guide] to request it.
Alternately, you can browse the repo files directly:
* EPEL 9:
https://dl.fedoraproject.org/pub/epel/9/Everything/x86_64/[x86_64],
https://dl.fedoraproject.org/pub/epel/9/Everything/s390x/[s390x],
https://dl.fedoraproject.org/pub/epel/9/Everything/ppc64le/[ppc64le],
https://dl.fedoraproject.org/pub/epel/9/Everything/aarch64/[aarch64],
https://dl.fedoraproject.org/pub/epel/9/Everything/source/tree/[sources]
* EPEL 8:
https://dl.fedoraproject.org/pub/epel/8/Everything/x86_64/[x86_64],
https://dl.fedoraproject.org/pub/epel/8/Everything/s390x/[s390x],
https://dl.fedoraproject.org/pub/epel/8/Everything/ppc64le/[ppc64le],
https://dl.fedoraproject.org/pub/epel/8/Everything/aarch64/[aarch64],
https://dl.fedoraproject.org/pub/epel/8/Everything/SRPMS/[sources]
* EPEL 7: https://dl.fedoraproject.org/pub/epel/7/x86_64/[x86_64],
https://dl.fedoraproject.org/pub/epel/7/ppc64le/[ppc64le],
https://dl.fedoraproject.org/pub/epel/7/SRPMS/[sources] (EPEL-7
for aarch64 is no longer supported as Red Hat ended support for this
architecture).
You can also browse these same directories on any of our
https://admin.fedoraproject.org/mirrormanager/mirrors/EPEL[mirrors].
[[end_of_life_releases]]
== END OF LIFE RELEASES
*THESE ARE NO LONGER SUPPORTED*
NOTE: Due to major security changes in SSL in the last 10 years, older
releases may not be able to directly point to these releases. As of
2021-01-22, EPEL-5 and 4 systems do not have the newer TLS 1.2 algorithms
that Internet servers are required to use for security reasons. The best
method for working with these is to have a newer system mirror the
entire archive and then for your systems to point to that mirror.
* EPEL 6: https://dl.fedoraproject.org/pub/archive/epel/6/[]
* EPEL 5: https://dl.fedoraproject.org/pub/archive/epel/5/[]
* EPEL 4: https://dl.fedoraproject.org/pub/archive/epel/4/[]
[[how_can_i_use_these_extra_packages]]
== How can I use these extra packages?
EPEL has an 'epel-release' package that includes GPG keys for package
signing and repository information. Installing this package for your
Enterprise Linux version should allow you to use normal tools such as
`yum` to install packages and their dependencies. By default the stable
EPEL repo is enabled, there is also a link:epel-testing['epel-testing'
repository] that contains packages that are not yet deemed stable.
* NOTE for RHN users: You need to also enable the *'optional*' repository
to use EPEL packages as they depend on packages in that repository. This
can be done by enabling the RHEL optional
https://access.redhat.com/kb/docs/DOC-11313[subchannel] for RHN-Classic.
For certificate-based subscriptions see
https://access.redhat.com/site/documentation/en-US/Red_Hat_Subscription_Management/1/html/RHSM/entitlements-and-yum.html#supplementary-repos[Red
Hat Subscription Management Guide].
* NOTE for RHEL 7 users with certificate subscriptions: EPEL 7 packages
assume that the *'optional*' repository (rhel-7-server-optional-rpms for
servers) and the *'extras*' repository (rhel-7-server-extras-rpms for
servers) are enabled. You can do this with:
`subscription-manager repos --enable rhel-7-server-optional-rpms --enable rhel-7-server-extras-rpms`
* NOTE for RHEL 8 users with certificate subscriptions: EPEL packages
assume that the *'codeready-builder*' repository is enabled. You can do
this with:
`subscription-manager repos --enable "codeready-builder-for-rhel-8-$(arch)-rpms"`
* NOTE for CentOS 8 and CentOS Stream 8 users: EPEL packages assume that the *'powertools*'
repository is enabled. You can do this with:
`dnf config-manager --set-enabled powertools`
* NOTE for CentOS users: You can install EPEL by running *yum install
epel-release*. The package is included in the CentOS Extras repository,
enabled by default.
You can verify these packages and their keys from the Fedora project's
keys page: https://fedoraproject.org/keys
[[can_i_rely_on_these_packages]]
== Can I rely on these packages?
The EPEL project strives to provide packages with both high quality and
stability. However, EPEL is maintained by a community of people who
generally volunteer their time and no commercial support is provided. It
is the nature of such a project that packages will come and go from the
EPEL repositories over the course of a single release. In addition, it
is possible that occasionally an incompatible update will be released
such that administrator action is required. By policy these are
announced in advance in order to give administrators time to test and
provide suggestions.
It is strongly recommended that if you make use of EPEL, and especially if you
rely upon it, that you subscribe to the
https://lists.fedoraproject.org/admin/lists/epel-announce.lists.fedoraproject.org/[epel-announce]
list. Traffic on this list is kept to a minimum needed to notify administrators
of important updates.
[[history_and_background_of_the_project]]
== History and background of the project
The EPEL project was born when Fedora maintainers realized that the same
infrastructure that builds and maintains packages for Fedora would be
great to also maintain add on packages for Enterprise Linux. Much of the
early need was driven by what Fedora infrastructure needed on the RHEL
machines that built and maintained Fedora. From there things have grown
to a large collection of varied packages. See
link:epel-about-history-philosophy[our history and Philosophy page] for
more information.
[[how_can_i_contribute]]
== How can I contribute?
EPEL is always looking for interested folks to help out. We
always need package maintainers, QA/testers, bug triagers and
documentation writers. Please see our link:epel-help[Joining EPEL]
page for more information on how to join EPEL.
[[communicating_with_epel]]
== Communicating with EPEL
There are many ways to communicate with EPEL and its members:
// This syntax is needed to get asciidoc to accept the weird link characters.
:epel-matrix: https://matrix.to/#/#epel:fedoraproject.org
* The https://web.libera.chat/?channels=#epel[#epel] IRC channel on
https://libera.chat[Libera Chat] offers real-time
support for EPEL users and developers.
This channel is bridged to {epel-matrix}[epel:fedoraproject.org] on Matrix.
* The https://lists.fedoraproject.org/admin/lists/epel-devel@lists.fedoraproject.org/[epel-devel]
mailing list is for general EPEL discussion.
https://www.redhat.com/archives/epel-devel-list/[Historic archives] are available.
* The
https://lists.fedoraproject.org/admin/lists/epel-announce@lists.fedoraproject.org/[epel-announce]
mailing list is a low volume mailing list for only important announcements.
* The
https://lists.fedoraproject.org/admin/lists/epel-package-announce@lists.fedoraproject.org/[epel-package-announce]
mailing list is a list that gets information about package updates as they
happen in the stable repository.
* If you find a bug in a EPEL maintained package, please report it to
https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora+EPEL[https://bugzilla.redhat.com/]
under the "Fedora EPEL" product.
* Infrastructure issues (mirrors, repos, etc.) should be reported to
https://pagure.io/releng/issues[Fedora releng].
:meeting-matrix: https://matrix.to/#/#meeting-1:fedoraproject.org
* The EPEL Steering Committee meets on Wednesday every week in the
https://chat.fedoraproject.org/#/room/#meeting-1:fedoraproject.org[Fedora Meeting 1]
Matrix channel. The time is **not** tied to U.S. daylight savings time, so it is at
18:00 UTC regardless of the time of year. Please check the time on the
https://calendar.fedoraproject.org/epel/[epel calendar]; sometimes
it can change or a meeting can be skipped. Feel free to join us! Logs of
past meetings can be viewed in
https://meetbot.fedoraproject.org/sresults/?group_id=epel&type=team[meetbot].
* The EPEL Steering Committee has
https://discussion.fedoraproject.org/t/join-us-for-the-epel-office-hours-every-month/37235[monthly
office hours for the EPEL project].
TIP: Ready to get started?
Check out or xref:getting-started.adoc[setup guide].

View file

@ -1 +0,0 @@
:year: 2021

View file

@ -1,15 +0,0 @@
This is an example of a partial file. Unlike files in `pages/`, files in this directory are not built as standalone pages, but only if they are included in a file within `pages/`. This stops fragments of pages being built and discovered by search engines.
A file in this directory can be included within any file in the `pages/` directory.
Most common use cases for partials are:
. Reusing attributes such as the current year or a release version throughout the entire module while being able to change it easily (such as changing "Fedora 33" to "Fedora 34" when a new release comes out).
. Reusing content such a banner or an infobox (`[NOTE]`, etc.) that appears on multiple pages and needs to have consistent content everywhere (such as a message on some of the quick-docs that warns the reader about their unreviewed status).
In these cases, you can use a partial to include the same content in multiple places, and you only need to change it once to get the change to appear in every spot it's included in. You can see the first example used in `pages/index.adoc` in this repository; note the include statement on top.
If you want to include this particular example somewhere, you can use the following syntax: `include::partial$partial-example.adoc[]`.
Note the use of `partial$` instead of an actual file location.
See link:https://docs.antora.org/antora/3.0/partials-directory/[Antora docs on partials] for more information about partials.

View file

@ -0,0 +1,22 @@
* xref:epel-about.adoc[About]
** xref:epel-about-history-philosophy.adoc[History and Philosophy]
** xref:epel-about-next.adoc[EPEL-Next]
** xref:epel-about-playground.adoc[EPEL-Playground]
* xref:epel-policy.adoc[Guidelines and Policies]
** xref:epel-policy-updates.adoc[Updates]
** xref:epel-policy-incompatible-upgrades.adoc[Incompatible Upgrades]
** xref:epel-policy-retirement.adoc[Package Retirement]
** xref:epel-policy-scl.adoc[Software Collections (SCL)]
** xref:epel-policy-missing-sub-packages.adoc[Missing RHEL Sub-Packages]
** xref:epel-policy-steering-committee.adoc[Steering Committee]
* xref:epel-help.adoc[Helping EPEL]
** xref:epel-qa.adoc[EPEL QA]
** xref:epel-packaging.adoc[Packaging]
** xref:epel-packaging-examples.adoc[Packaging Examples]
** xref:epel-package-maintainers.adoc[Package Maintainers]
** xref:epel-package-maintainer-generic-description.adoc[EPEL Package Maintainer Generic Description]
** xref:epel-rhel-entitlements.adoc[RHEL Entitlements]
** xref:epel-packagers-sig.adoc[EPEL Packagers SIG]
** xref:fedora-package-in-epel.adoc[Get Fedora Package in EPEL]
* xref:epel-package-request.adoc[Request Packages]
* xref:epel-faq.adoc[FAQ]

View file

@ -0,0 +1,146 @@
include::partial$attributes.adoc[]
= Extra Packages for Enterprise Linux (EPEL)
[[what_is_epel_next]]
== What is EPEL-Next?
EPEL packages are built against RHEL. EPEL Next packages are built against CentOS Stream.
EPEL-Next is not a complete rebuild of all the EPEL packages, but only those packages that need to be rebuilt to install on CentOS Stream. The EPEL-Next repo is meant to be layered on top of the regular EPEL repository.
Learn more about EPEL-Next on the following page:
* link:epel-about-next[EPEL Next]
[[what_packages_and_versions_are_available_in_epel]]
== What packages and versions are available in EPEL?
Since EPEL is part of the Fedora project, you can search the available packages in the
https://packages.fedoraproject.org/[Fedora Packages web app].
This provides an overview of available versions across various EPEL branches.
If you find a package that is not yet available in the EPEL branch you would like it to be,
please follow xref:epel-package-request.adoc[this guide] to request it.
Alternately, you can browse the repo files directly:
* EPEL 9:
https://dl.fedoraproject.org/pub/epel/9/Everything/x86_64/[x86_64],
https://dl.fedoraproject.org/pub/epel/9/Everything/s390x/[s390x],
https://dl.fedoraproject.org/pub/epel/9/Everything/ppc64le/[ppc64le],
https://dl.fedoraproject.org/pub/epel/9/Everything/aarch64/[aarch64],
https://dl.fedoraproject.org/pub/epel/9/Everything/source/tree/[sources]
* EPEL 8:
https://dl.fedoraproject.org/pub/epel/8/Everything/x86_64/[x86_64],
https://dl.fedoraproject.org/pub/epel/8/Everything/s390x/[s390x],
https://dl.fedoraproject.org/pub/epel/8/Everything/ppc64le/[ppc64le],
https://dl.fedoraproject.org/pub/epel/8/Everything/aarch64/[aarch64],
https://dl.fedoraproject.org/pub/epel/8/Everything/SRPMS/[sources]
* EPEL 7: https://dl.fedoraproject.org/pub/epel/7/x86_64/[x86_64],
https://dl.fedoraproject.org/pub/epel/7/ppc64le/[ppc64le],
https://dl.fedoraproject.org/pub/epel/7/SRPMS/[sources] (EPEL-7
for aarch64 is no longer supported as Red Hat ended support for this
architecture).
You can also browse these same directories on any of our
https://admin.fedoraproject.org/mirrormanager/mirrors/EPEL[mirrors].
[[end_of_life_releases]]
== END OF LIFE RELEASES
*THESE ARE NO LONGER SUPPORTED*
NOTE: Due to major security changes in SSL in the last 10 years, older
releases may not be able to directly point to these releases. As of
2021-01-22, EPEL-5 and 4 systems do not have the newer TLS 1.2 algorithms
that Internet servers are required to use for security reasons. The best
method for working with these is to have a newer system mirror the
entire archive and then for your systems to point to that mirror.
* EPEL 6: https://dl.fedoraproject.org/pub/archive/epel/6/[]
* EPEL 5: https://dl.fedoraproject.org/pub/archive/epel/5/[]
* EPEL 4: https://dl.fedoraproject.org/pub/archive/epel/4/[]
[[can_i_rely_on_these_packages]]
== Can I rely on these packages?
The EPEL project strives to provide packages with both high quality and
stability. However, EPEL is maintained by a community of people who
generally volunteer their time and no commercial support is provided. It
is the nature of such a project that packages will come and go from the
EPEL repositories over the course of a single release. In addition, it
is possible that occasionally an incompatible update will be released
such that administrator action is required. By policy these are
announced in advance in order to give administrators time to test and
provide suggestions.
It is strongly recommended that if you make use of EPEL, and especially if you
rely upon it, that you subscribe to the
https://lists.fedoraproject.org/admin/lists/epel-announce.lists.fedoraproject.org/[epel-announce]
list. Traffic on this list is kept to a minimum needed to notify administrators
of important updates.
[[history_and_background_of_the_project]]
== History and background of the project
The EPEL project was born when Fedora maintainers realized that the same
infrastructure that builds and maintains packages for Fedora would be
great to also maintain add on packages for Enterprise Linux. Much of the
early need was driven by what Fedora infrastructure needed on the RHEL
machines that built and maintained Fedora. From there things have grown
to a large collection of varied packages. See
link:epel-about-history-philosophy[our history and Philosophy page] for
more information.
[[how_can_i_contribute]]
== How can I contribute?
EPEL is always looking for interested folks to help out. We
always need package maintainers, QA/testers, bug triagers and
documentation writers. Please see our link:epel-help[Joining EPEL]
page for more information on how to join EPEL.
[[communicating_with_epel]]
== Communicating with EPEL
There are many ways to communicate with EPEL and its members:
// This syntax is needed to get asciidoc to accept the weird link characters.
:epel-matrix: https://matrix.to/#/#epel:fedoraproject.org
* The https://web.libera.chat/?channels=#epel[#epel] IRC channel on
https://libera.chat[Libera Chat] offers real-time
support for EPEL users and developers.
This channel is bridged to {epel-matrix}[epel:fedoraproject.org] on Matrix.
* The https://lists.fedoraproject.org/admin/lists/epel-devel@lists.fedoraproject.org/[epel-devel]
mailing list is for general EPEL discussion.
https://www.redhat.com/archives/epel-devel-list/[Historic archives] are available.
* The
https://lists.fedoraproject.org/admin/lists/epel-announce@lists.fedoraproject.org/[epel-announce]
mailing list is a low volume mailing list for only important announcements.
* The
https://lists.fedoraproject.org/admin/lists/epel-package-announce@lists.fedoraproject.org/[epel-package-announce]
mailing list is a list that gets information about package updates as they
happen in the stable repository.
* If you find a bug in a EPEL maintained package, please report it to
https://bugzilla.redhat.com/enter_bug.cgi?product=Fedora+EPEL[https://bugzilla.redhat.com/]
under the "Fedora EPEL" product.
* Infrastructure issues (mirrors, repos, etc.) should be reported to
https://pagure.io/releng/issues[Fedora releng].
:meeting-matrix: https://matrix.to/#/#meeting-1:fedoraproject.org
* The EPEL Steering Committee meets on Wednesday every week in the
https://chat.fedoraproject.org/#/room/#meeting-1:fedoraproject.org[Fedora Meeting 1]
Matrix channel. The time is **not** tied to U.S. daylight savings time, so it is at
18:00 UTC regardless of the time of year. Please check the time on the
https://calendar.fedoraproject.org/epel/[epel calendar]; sometimes
it can change or a meeting can be skipped. Feel free to join us! Logs of
past meetings can be viewed in
https://meetbot.fedoraproject.org/sresults/?group_id=epel&type=team[meetbot].
* The EPEL Steering Committee has
https://discussion.fedoraproject.org/t/join-us-for-the-epel-office-hours-every-month/37235[monthly
office hours for the EPEL project].

View file

@ -1,18 +0,0 @@
#!/bin/sh
if [ "$(uname)" = "Darwin" ]; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo "The preview will be available at http://localhost:8080/"
docker run --rm -v "$(pwd):/antora:ro" -v "$(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro" -p 8080:80 nginx
elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then
# Running on Linux.
# Fedora Workstation has python3 installed as a default, so using that
echo ""
echo "The preview is available at http://localhost:8080"
echo ""
cd ./public
python3 -m http.server 8080
fi

View file

@ -7,14 +7,14 @@ content:
branches: HEAD
ui:
bundle:
url: https://asamalik.fedorapeople.org/ui-bundle.zip
url: https://gitlab.com/fedora/docs/docs-website/ui-bundle/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
default_layout: with_menu
output:
clean: true
dir: ./public
destinations:
- provider: archive
runtime:
fetch: true
cache_dir: ./cache
urls:
html_extension_style: indexify