Compare commits

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

11 commits

Author SHA1 Message Date
e502e25472 build: Update with latest version from template
Fix over quoting of ${cmd}.
2022-03-09 17:31:19 +01:00
1a092bd743 Update configuration for Antora 3.0 2022-03-09 17:31:19 +01:00
5578213235 build & preview: Update with latest version from template 2022-03-09 17:31:19 +01:00
0ad26b59a7 Update modules/install-guide/pages/install/Preparing_for_Installation.adoc
Users should not run MediaWriter with sudo.
2021-01-27 03:09:03 +01:00
3735970294 Update a link to Cobbler in Network-Based Installations 2021-01-13 01:22:18 +01:00
11c92f98d5 Update modules/install-guide/pages/advanced/Network_based_Installations.adoc
Spelling correction
2020-08-26 00:00:49 +02:00
Owen DeLong
49826adf29 Update modules/install-guide/pages/advanced/Network_based_Installations.adoc
Corrected RFC number for DHCP Architecture Option (digits were transposed claiming 4758, correct number is 4578).
2020-02-07 10:14:27 +01:00
2ab060bcfc Issue 33 - fix links for iso checksum verification 2019-11-07 15:33:00 +01:00
cc6d18d3a7 Update LICENSE 2019-09-17 14:18:17 +02:00
9d11215378 Update build scripts 2019-09-17 14:18:17 +02:00
440143a4f8 Branch for f31 and update version numbers 2019-09-16 16:12:26 +02:00
8 changed files with 69 additions and 61 deletions

10
LICENSE Normal file
View file

@ -0,0 +1,10 @@
The text of and illustrations in this document are licensed by Red Hat
under a Creative Commons AttributionShare 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.
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

@ -1,5 +1,5 @@
---
name: fedora
version: rawhide
version: f31
# Navigation is in the main 'fedora' component:
# https://pagure.io/fedora-docs/release-docs-home

View file

@ -1,35 +1,51 @@
#!/bin/sh
image="antora/antora"
image="docker.io/antora/antora"
cmd="--html-url-extension-style=indexify site.yml"
if [ "$(uname)" == "Darwin" ]; then
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.
docker run --rm -it -v $(pwd):/antora $image $cmd
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
elif uname | grep -iq linux; then
# Running on Linux.
# Check whether podman is available, else faill back to docker
# which requires root.
if [ -f /usr/bin/podman ]; then
runtime="podman"
if [ -f /usr/local/bin/antora ]; then
/usr/local/bin/antora "${cmd}"
elif uname -m | grep -iwq aarch64; then
echo "no antora/aarch64 container try just \`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
runtime="docker"
fi
if groups | grep -wq "docker"; then
# Check if the current user is in the "docker" group. If true, no sudo is needed.
echo ""
echo "This build script is using $runtime to run the build in an isolated environment."
echo ""
$runtime run --rm -it -v $(pwd):/antora:z $image $cmd
else
# User isn't in the docker group; run the command with sudo.
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 $runtime run --rm -it -v $(pwd):/antora:z $image $cmd
echo "Error: Container runtime haven't been found on your system. Fix it by:"
echo "$ sudo dnf install podman"
exit 1
fi
fi

View file

@ -5,12 +5,12 @@
:HOLDER: Red Hat, Inc. and others
:NEXTVER: 31
:NEXTVER: 32
:PREVVER: 29
:PREVVER: 30
:PRODUCT: Fedora
:PRODVER: 30
:PRODVER: 31
:YEAR: 2019

View file

@ -1,4 +1,3 @@
:experimental:
include::{partialsdir}/entities.adoc[]
@ -78,7 +77,7 @@ option routers 192.168.1.1;
. Add entries to point clients to their bootloader and the server that provides it to your subnet configuration in `/etc/dhcp/dhcpd.conf`. Because DHCP clients provide the server with identifying information along with their address request, BIOS clients and UEFI clients can each be directed to the correct bootloader.
+
----
# refer to RFC4758 for possible arch option values
# refer to RFC4578 for possible arch option values
option arch code 93 = unsigned integer 16;
subnet 192.168.1.0 netmask 255.255.255.0 {
@ -249,6 +248,8 @@ Fedora Infrastructure maintains instructions for a configuring a local mirror at
[[sect-install-server-cobbler]]
== Advanced network installations with Cobbler
For more complex environments, {PRODUCT} offers the [package]*cobbler* installation server. Tasks like managing kickstart configurtations, coordinating repositories, maintaining dns records, dhcp servers, and even puppet manifests are effectively automated by [package]*cobbler*.
For more complex environments, {PRODUCT} offers the [package]*cobbler* installation server. Tasks like managing kickstart configurations, coordinating repositories, maintaining dns records, dhcp servers, and even puppet manifests are effectively automated by [package]*cobbler*.
While levaraging all of the features provided by cobbler can be relatively simple, the full functionality of this powerful tool is too broad to be documented in this guide. The cobbler community provides excellent documentation at link:++http://www.cobblerd.org/category/manuals/++[] to accompany the packages in the Fedora repository.
While levaraging all of the features provided by cobbler can be relatively simple, the full functionality of this powerful tool is too broad to be documented in this guide. The cobbler community provides documentation at link:++https://cobbler.github.io/++[] to accompany the packages in the Fedora repository.
Alternatively, you may also be interested in **Foreman**. You can find official documentation as well as downloads on the project website at link:++https://www.theforeman.org/++[].

View file

@ -1,4 +1,3 @@
:experimental:
include::{partialsdir}/entities.adoc[]
@ -63,7 +62,7 @@ $ [command]#sudo dnf install mediawriter#
+
[subs="quotes, macros, attributes"]
----
$ [command]#sudo mediawriter#
$ [command]#mediawriter#
----
+
or in [application]*Gnome 3* select *Activities,* then select *Utilities*, and then click on [application]*Fedora Media Writer*.
@ -163,12 +162,12 @@ You can also choose a Fedora _Spin_ featuring favorite alternative desktops or t
Because transmission errors or other problems may corrupt the Fedora image you have downloaded, it is important to verify the file's integrity. After the images are created, an operation is performed on the file that produces a value called a `checksum` using a complex mathematical algorithm. The operation is sufficiently complex that *any change* to the original file will produce a different checksum.
By calculating the image's `checksum` on your own computer and comparing it to the original `checksum`, you can verify the image has not been tampered with or corrupted. The original checksum values are provided at link:++https://fedoraproject.org/verify++[], and are [command]#gpg# signed to demonstrate their integrity.
By calculating the image's `checksum` on your own computer and comparing it to the original `checksum`, you can verify the image has not been tampered with or corrupted. The original checksum values are provided at link:++https://getfedora.org/security/++[], and are [command]#gpg# signed to demonstrate their integrity.
[[sect-verifying-windows]]
==== Verifying checksums on Windows systems
. Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://fedoraproject.org/verify++[]
. Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://getfedora.org/security/++[]
. Open a [command]#powershell# session.
@ -219,7 +218,7 @@ echo "Checksum test failed."
[[sect-verifying-nix]]
==== Verifying checksums on Linux and OSX systems
. Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://fedoraproject.org/verify++[]
. Download the Fedora image of your choice from link:++https://fedoraproject.org/get-fedora++[] and the corresponding checksum file from link:++https://getfedora.org/security/++[]
. Open a terminal window, and navigate to the directory with the downloaded files.
+

View file

@ -1,36 +1,18 @@
#!/bin/sh
if [ "$(uname)" == "Darwin" ]; then
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
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
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 [ -f /usr/bin/podman ]; then
runtime="podman"
else
runtime="docker"
fi
if groups | grep -wq "docker"; then
# Check if the current user is in the "docker" group. If true, no sudo is needed.
echo ""
echo "This build script is using $runtime to run the build in an isolated environment."
echo "The preview will be available at http://localhost:8080/"
echo ""
$runtime run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx
else
# User isn't in the docker group; run the command with sudo.
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 ""
echo "The preview will be available at http://localhost:8080/"
echo ""
sudo $runtime run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx
fi
# 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

@ -1,12 +1,12 @@
site:
title: Local Preview
start_page: fedora:install-guide:index
start_page: fedora:install-guide:index.adoc
content:
sources:
- url: .
branches: HEAD
- url: https://pagure.io/fedora-docs/release-docs-home.git
branches: master
branches: f31
ui:
bundle:
url: https://asamalik.fedorapeople.org/ui-bundle.zip
@ -18,5 +18,5 @@ output:
destinations:
- provider: archive
runtime:
pull: true
fetch: true
cache_dir: ./cache