Compare commits

..

3 commits

Author SHA1 Message Date
2c6228b29f Fix versionnum in index 2019-09-16 16:37:01 +02:00
999a6d5e63 Fix version number in antora.yml 2019-09-16 16:20:50 +02:00
fc56117653 Branch for f31 and update version numbers 2019-09-16 15:36:05 +02:00
25 changed files with 50 additions and 1519 deletions

427
LICENSE
View file

@ -1,427 +0,0 @@
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.

View file

@ -1,29 +1,43 @@
# Fedora User Documentation Home
# Fedora Modularity Docs
The Fedora User Documentation subpage on the docs front page. Also pulls in the Release Notes.
Please report Issues and submit Pull Requests for **Content Fixes** here.
Never done a pull request (or "PR")? Here's the [Pagure documentation for
Pull Requests](https://docs.pagure.org/pagure/usage/pull_requests.html).
## Published documentation
The published version of this documentation is available at:
[https://docs.fedoraproject.org/en-US/fedora/latest/](https://docs.fedoraproject.org/en-US/fedora/latest/)
General appearance issues and publishing issues should be reported against
the [publishing software](https://pagure.io/fedora-docs/docs-fp-o).
## Contributing
## How to edit these documents
We welcome contributions! Whether it's fixing a typo, reporting an outdated
page, or writing new content — every little bit helps.
All of this is written in AsciiDoc. It's a simple mostly-plain-text
markup language. You may want to look at:
> **Note:** This is a versioned repository — there is a separate branch for each
> Fedora release. Pull requests should generally go to these release-specific branches.
> Branch `main` is only used as a template from which each new version is branched.
See the [Fedora Docs Contributor Guide](https://docs.fedoraproject.org/en-US/fedora-docs/contributing-docs/)
for how to get started.
* [AsciiDoc Syntax Quick Reference](http://asciidoctor.org/docs/asciidoc-syntax-quick-reference/)
* [AsciiDoc Writers Guide](http://asciidoctor.org/docs/asciidoc-writers-guide/)
* [Antora Documentation](https://docs.antora.org/antora/1.0/page/)
Please report **content issues** in this repository.
For general site/publishing issues, use the
[Fedora Docs Website repository](https://forge.fedoraproject.org/docs/docs-fp-o).
## Contact
- **Matrix:** [#docs:fedoraproject.org](https://matrix.to/#/#docs:fedoraproject.org)
- **Private comms:** Use our FAS emails for anything that shouldn't be public.
- **Discussion forums:** [discussion.fedoraproject.org](https://discussion.fedoraproject.org/tag/docs-team/337)
## Local preview
This repo includes scripts to build and preview the contents of this repository.
**NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions.
Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions.
To build and preview the site, run:
```
$ ./build.sh && ./preview.sh
```
The result will be available at http://localhost:8080
### Installing docker on Fedora
```
$ sudo dnf install docker
$ sudo systemctl start docker && sudo systemctl enable docker
```

View file

@ -1,10 +1,8 @@
name: fedora
title: Fedora User Docs
version: rawhide
# Remove or set the prerelease key to "False" when promoting this release to stable
prerelease: True
version: f31
nav:
- modules/ROOT/nav.adoc
#- modules/ROOT/nav.adoc
- modules/release-notes/nav.adoc
#- modules/install-guide/nav.adoc
# modules/system-administrators-guide/nav.adoc
- modules/install-guide/nav.adoc
- modules/system-administrators-guide/nav.adoc

View file

@ -1,278 +0,0 @@
#!/bin/bash
# script to watch source directory for changes, and re-run build and preview
script_name="docsbuilder.sh"
script_source="https://gitlab.com/fedora/docs/templates/fedora-docs-template/-/raw/main/${script_name}"
version="1.2.0"
image="docker.io/antora/antora"
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 [ -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 --stacktrace
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 ""
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

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 158 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 28 KiB

File diff suppressed because one or more lines are too long

Before

Width:  |  Height:  |  Size: 6.7 KiB

View file

@ -1,6 +1 @@
* xref:index.adoc[Fedora User Documentation]
** xref:getting-started.adoc[Getting started]
*** xref:fedora-downloads-info.adoc[Fedora Downloads]
*** xref:preparing-boot-media.adoc[Preparing Boot Media]
** xref:system-upgrade.adoc[System upgrade]
// ** A newbee's primer
* xref:index.adoc[starting page]

View file

@ -1,88 +0,0 @@
= Fedora Downloads
The Fedora docs team
:revnumber: F38
:revdate: 2023-04-18
[abstract]
____
This section provides guidance on how to select the appropriate installation media for the download.
____
As already mentioned, the https://fedoraproject.org[Fedora Project website] provides all the Fedora Downloads.
The landing page lists all available Editions, Spins, Labs, etc. as described in xref::getting-started.adoc[Getting started], and links to the proper details pages.
Navigate to the page that covers the Fedora variant you decided to use.
Now you have to make additional choices as described here.
* the _architecture of the hardware_ to install Fedora on
* the _type of installation media_ that fits your needs best
== Hardware architecture
You have to determine: Which architecture is my computer?
The system architecture is essentially determined by the processor.
Fedora officially supports Intel/AMD __**x86_64**__ and ARM __**aarch64**__ architecture.
Additionally installation media and Fedora support for PowerPC _ppc64le_ and 'big iron' _s390x_ are available - just in case.
Installing Fedora using a wrong architecture medium is not possible.
Consult your manufacturer's documentation for details on your processor.
If you already use a Linux distribution on the respective computer, you can enter `uname -m` within a terminal to identify your architecture.
If you use another operating system, use your preferred search engine to find out how to identify the architecture on the respective computer.
Alternatively, you can search for your hardware (e.g., processor/cpu model, vendor product number of the computer): the processor/cpu determines the architecture.
If you are not sure about your architecture, you should have a look on the table below: this could help you to indicate what you have.
[[List-Processor_and_Architecture_Types]]
.Processor and architecture types
[options="header"]
|===
|Processor manufacturer and types of computer|Architecture type for Fedora
|Most computers with Intel and AMD processors; Mac computers before Apple M1; most server, workstation, desktop and laptop type computers; some netbooks and tablets|`x86_64`
|Most processors other than Intel and AMD; Mac computers beginning with Apple M1; Raspberry Pi and most comparable devices; most tablets; some netbooks|`ARM® aarch64`
|===
Regarding ARM architecture, Fedora supports only 64-bit architecture, aarch64 or arm8, as of release 37 and newer.
The older 32-bit architecture, armhfp or arm7, is dropped.
== Media Types
Fedora provides 4 different types of installation media that meet different requirements.
Live images:: Live images ("Live ISO") are designed to boot the computer and to allow you to preview Fedora before installing it. Instead of booting directly into the installer, a live image loads the same environment you will get after installation.
+
The file type is '__.iso__'. You have to transfer the file to a boot medium, usually an USB stick, or still a CD or DVD.
+
Use a live image to install your favorite system, test Fedora on new hardware, troubleshoot, or share with friends.
+
Fedora Workstation, the Fedora Spins and some Fedora Labs are the only ones provided as live images.
Standard images:: Standard images ("Standard ISO") are designed to boot the computer, as well, but boot directly into the installation environment. They include all files needed for the installation and some offer further choices and configuration options.
+
The file type is '__.iso__'. You have to transfer the file to a boot medium, usually an USB stick, or still a CD or DVD.
+
Use a standard image to perform an offline installation without any internet connection or the available connection is slow or unstable.
+
Fedora Server, Fedora IoT, Fedora CoreOS, Fedora Silverblue, and Fedora Kinoite are available as standard images.
Netinstall images:: Netinstall images ("Netinstall ISO") are designed to boot the computer, as well, and boot directly into the installation environment. But they provide just the minimum system files to boot and to connect to the internet. Subsequently the system has to download all files needed for installation from the online Fedora package repositories.
+
The file type is '__.iso__'. You have to transfer the file to a boot medium, usually an USB stick, or still a CD or DVD.
+
Use a netinstall image if the system has a stable and fairly fast Internet connection. The installation already accesses the latest updates.
+
The Netinstall images currently available are:
* the Fedora Server installation image.
* the "Everything ISO" image. This image allows the user to select from a range of desktop environments, and groups of optional software packages. Depending on what software is selected, the resulting install may be the equivalent of one of the Fedora editions or spins, or it may be a customized install to the user's requirements.
Filesystem disk images:: Disk images provide a _preinstalled and preconfigured_ ready to run file system for a specific runtime environment like a virtual machine, e.g. cloud system, or specific hardware like single board computers (SBC), e.g. Raspberry Pi or its alternatives.
+
The file type is mostly either '__.raw__' or '__.qcow2__'. You have to use a runtime specific installation program, provided either by Fedora (e.g. in case of SBCs) or the runtime provider (e.g. one of the cloud systems like Amazon AWS).
+
Use a filesystem disk image if you want to use one of the intended runtime environments.

View file

@ -1,157 +0,0 @@
= Getting Started
The Fedora docs team
:revnumber: F42
:revdate: 2025-08-20
// Redirect the old (generic) installation guide to this page
:page-aliases: rawhide@fedora:install-guide:index.adoc
// on 64-bit AMD, Intel and Arm SystemReady machines
[abstract]
This guide intends to provide an overview of and an introduction to installing Fedora. It takes into account users with varying levels of knowledge and experience with Fedora, and therefore covers greater detail than some users are likely to require. This should specifically help new users to complete the installation process without interruptions. Users may skip sections about familiar topics.
== Introduction
This guide covers installation of Fedora, a Linux distribution built on free and open source software. This manual helps you install Fedora on desktops, laptops, and servers. The installation system is easy to use, even if you lack previous knowledge of Linux or computer networks. If you select default options, Fedora provides a complete operating system, with solid _security settings_ and _including productivity applications_, Internet utilities, and administration tools.
Fedora is provided in several variants tailored for special purposes. We call them *Editions*, *Atomic Desktops* and *Spins*.
_Because of these differences, there is no single installation procedure._
Most Fedora variants, but not all, use Anaconda, the Fedora installer, but in a way that is quite different in detail.
Therefore, _each edition describes the installation separately_. Most spins are based on one of the editions, mostly Fedora Workstation, and use the corresponding installation procedure.
Nevertheless, there are some preparatory steps that are almost the same for all variants, e.g. you need to prepare installation media.
== Fedora variants and how to install
=== Editions
Fedora Workstation::
This variant (using GNOME as the desktop environment) is installed by using a Live USB, CD, or DVD.
+
Software download at https://fedoraproject.org/workstation/download/
Fedora KDE Plasma Desktop::
This variant (using KDE Plasma as the desktop environment) is also installed by using a Live USB, CD, or DVD.
+
Software download at https://fedoraproject.org/kde/download/
Fedora Server Edition::
This variant provides a flexible and highly adaptable Server, suitable to provide a wide range of services.
+
The project provides a dedicated https://docs.fedoraproject.org/en-US/fedora-server/[installation guide] and documentation about usage and administration.
+
Software download at https://fedoraproject.org/server/download/
Fedora IoT Edition::
This variant implements a server for the 'Internet of Things' or 'edge computing'.
+
The project provides a dedicated https://docs.fedoraproject.org/en-US/iot/[installation guide] and documentation about usage and administration.
+
Software download at https://fedoraproject.org/iot/download/
Fedora CoreOS Edition::
A minimal, container-focused operating system, designed for clusters but also operable standalone. The project provides a https://docs.fedoraproject.org/en-US/fedora-coreos/getting-started/[Getting Started] guide.
+
Software download at https://fedoraproject.org/coreos/download/?stream=stable
Fedora Cloud::
As the name indicates, it focuses on Fedora on cloud networks. Installation and usage follows the respective cloud systems.
+
More information at https://fedoraproject.org/cloud/
=== Spins
Fedora Workstation Spins::
Most spins use a Live CD, DVD or USB for installation.
+
Software download at https://fedoraproject.org/spins/
=== Atomic Desktops
Atomic desktops use a read-only root filesystem. This means that every installation is identical to every other installation of the same version.
The operating system root filesystem on disk is exactly the same from one machine to the next, and it never changes as it is used.
Atomic desktops use the Anaconda installer, but have some limitations on installation options compared to Editions and Spins. The
https://docs.fedoraproject.org/en-US/fedora-silverblue/installation/[Silverblue installation documentation] describes these limitations,
which apply to all the Fedora atomic desktop variants
Fedora Silverblue::
An atomic desktop variant of Fedora, featuring the GNOME desktop, and an excellent platform for container-focused workflows.
+
More information at https://fedoraproject.org/atomic-desktops/silverblue/
Fedora Kinoite::
An atomic desktop variant of Fedora, featuring the KDE Plasma desktop.
+
More information at https://fedoraproject.org/atomic-desktops/kinoite/
Fedora Sway Atomic::
An atomic desktop variant of Fedora, featuring the Sway tiling window manager.
+
More information at https://fedoraproject.org/atomic-desktops/sway/
Fedora Budgie Atomic::
An atomic desktop variant of Fedora, featuring the Budgie desktop.
+
More information at https://fedoraproject.org/atomic-desktops/budgie/
Fedora COSMIC Atomic::
An atomic desktop variant of Fedora, featuring the COSMIC desktop (currently in alpha version).
+
More information at https://fedoraproject.org/atomic-desktops/cosmic/
=== Labs
Fedora Labs::
Curated bundles of purpose-driven software, maintained by community members. The respective compilations are either installed as independent, complete Fedora versions or complement existing Fedora installations.
+
https://labs.fedoraproject.org
== General preparations
According to different usage and purposes the variation not only differ in their installation process, they differ in administration and usage. To learn how to use an installed Fedora system, see the manuals available at the specific variant documentation pages.
Regarding installation, be especially prepared for the fact that each variant requires additional post-installation processes.
Despite all the differentiation, some things are the same for all variants.
=== Download the software deliverables
The differentiation according to tasks and areas of application corresponds to a differentiation of the download options and the further processing.
To find out more about Fedora download options, see xref:fedora-downloads-info.adoc[Fedora Downloads].
Visit the link:++https://fedoraproject.org/++[Fedora Project website] to download a distribution file.
=== Prepare boot media
An install on hardware usually requires to transfer the download file to a bootable medium, mostly a USB stick.
xref:preparing-boot-media.adoc#fedora_media_writer[Fedora Media Writer] is the tool of choice, developed and supported by Fedora.
Alternatively you may try https://etcher.balena.io/[balenaEtcher] or the https://www.ventoy.net/en/index.html[Ventoy project], both available for Linux, macOS, and Windows.
The latter is specifically useful if you want to have several distributions and versions available on one stick.
== Getting Additional Help
If you encounter any problems which are not described in documentation, you might get help from members of the community - developers, users, and others.
There are many ways to get help: the Ask Fedora website, mailing lists, forums, or IRC.
The discussion forum https://discussion.fedoraproject.org/c/ask/6[Ask Fedora] is the recommended way to start with.
See xref:index.adoc#_getting_help[Getting help] for detailed information.
=== NVIDIA
If you use an NVIDIA GPU and are experiencing significant visual issues while running Fedora from a live USB, it could be that your GPU is not fully compatible with the FOSS Nouveau driver.
One possible workaround for this situation is to do the following 3 steps:
1. During the live USB boot process, hit `e` at the GRUB boot menu.
2. Find the line that begins with `linux`, and add `nouveau.modeset=0` to the end of that line.
3. Press `<ctrl>` + `x` to resume the boot process.

View file

@ -1,113 +1,19 @@
include::partial$attributes.adoc[]
= Fedora 31 User Documentation
Fedora documentation describes how to install and use the Fedora operating system and the software packaged by the Fedora Project.
= Fedora Linux User Documentation
The Fedora docs team
:revnumber: {PRODVER}
:revdate: 2025-09-01
// :revremark: a new beginning
This section contains three books about Fedora 31:
:experimental:
* xref:f31@fedora:release-notes:index.adoc[Fedora 31 Release Notes]
* xref:f31@fedora:install-guide:index.adoc[Fedora 31 Installation Guide]
* xref:f31@fedora:system-administrators-guide:index.adoc[Fedora 31 System Administrators Guide]
The Fedora Documentation Project only actively maintains documentation for the most recent release and the one before it.
We also preserve older documentation on this site for historical interest and to acknowledge the generous contribution of time and effort by many, many writers and translators.
In 1997, Richard Stallman wrote:
[abstract]
____
The Fedora documentation provides extensive information on how to install and use the Fedora operating system and the software packaged by the Fedora Project. Fedora is a large project. Therefore, the focus here is on basic explanations and references to detailed documentation of the various subprojects. A special focus is on making it easier for new users to get started.
"The biggest deficiency in free operating systems is not in the software — it is the lack of good free manuals that we can include in these systems.”footnote:[Free Software and Free Manuals, available from link:http://www.gnu.org/philosophy/free-doc.html[]]
____
Free Software has produced outstanding technical achievements and solutions over the past decades. Just one example is the Apache server, which is used today by the vast majority of websites and provides the entire Internet with information. This quickly overshadows a fact that Richard Stallman emphasized as early as 1997:
_"The biggest deficiency in free operating systems is not in the software — it is the lack of good free manuals that we can include in these systems.” footnote:[Free Software and Free Manuals, available from link:http://www.gnu.org/philosophy/free-doc.html[]]_
It is this spirit that inspires the Fedora documentation team to do the often tough and time-consuming work on our documentation.
You'll find here a bunch of information:
xref:getting-started.adoc[Getting started]::
*First time with Fedora Linux?* New users find here extensive information to get Fedora up and running.
xref:system-upgrade.adoc[System upgrade]::
*Do you already have a Fedora Linux edition or Spin up and running?* You don't need to reinstall your system to get the new release. Fedora has put a lot of work into making an in-place update reliable and fully automated.
xref:release-notes:index.adoc[Fedora {PRODVER} release notes]::
Contains extensive information about new and modified features of the current release. Users are advised to skim this information to check if they may be affected by one of the changes or are now able to resolve an issue with a new feature.
xref:f{PREVVER}@release-notes:index.adoc[Fedora {PREVVER} release notes]::
Fedora supports the current and the previous release. As a reference here is a quick link to the previous release notes.
+
In the top bar, you can select older release notes.
A newbie's primer::
Are you new to Linux? Here we provide some facts, vocabulary, and links for a https://docs.fedoraproject.org/en-US/quick-docs/getting-started-guide/[first orientation].
You may also look at link:++https://fedoramagazine.org/++[Fedora Magazine], featuring often-updated articles of interest to Fedora users from beginner to expert, and from Raspberry Pi to the desktop to servers to the cloud.
== Getting help
There are many places on the internet that can help you when you encounter a problem not described in this chapter: discussion boards, blogs, IRC, and more. Some of the more popular places where you can find help include:
* link:++https://discussion.fedoraproject.org/c/ask/6++[Ask Fedora] - Fedora's knowledge base and community-driven question-and-answer site, available in multiple languages
* The #fedora Matrix room on link:++https://chat.fedoraproject.org/#/room/#fedora:fedoraproject.org++[Fedora Chat] - one of the main Matrix/IRC channels used by Fedora users, English only
// pboy: removed because the wiki is outdated
// * link:++https://fedoraproject.org/wiki/++[Fedora Project Wiki] - the official wiki for Fedora Project
* You may also look at link:++https://fedoramagazine.org/++[Fedora Magazine], featuring often-updated articles of interest to Fedora users from beginner to expert
* link:++https://unix.stackexchange.com/++[Stack Exchange] - an English language Q&A board, not specific to Fedora
[NOTE]
====
The above list is by no means complete - you can find help in many other places as well.
Additional information about available resources such as Matrix rooms and mailing lists is available at xref:project:ROOT:communications.adoc[].
====
Before you open a new discussion or ask anyone for help on IRC, you should always do some research on your own. If you are encountering an issue, there is usually a good chance that someone else ran into the same problem before you and published a solution somewhere. Opening a discussion about something already explained elsewhere, or asking a common question that has been answered many times before, is not likely to result in a friendly, constructive response.
When you ask for help troubleshooting problems related to the installation, you may be asked to provide log files generated by the installer. Consult the corresponding documentation to learn how to access a suitable log file.
// ToDo: Add information about ihow to handle log files, see Anaconda doc and planned "troubleshooting" section in QuickDocs.
== Join the community
Fedora has a vibrant community. The meeting place is the https://discussion.fedoraproject.org/tag/docs[Fedora Discussion] Forum.
Fedora is a huge project. Some of us will remember when we first started getting involved in Fedora.
It was not easy to get an overview and to find a way to contribute one's interests and skills in the best possible way.
Fortunately, we now have an initiative to pave the way for new participants and provide some guidance.
Have a look at xref:project:ROOT:join.adoc#_not_sure_where_to_start_come_hang_out_with_us['Not sure where to start? Come hang out with us!'] and/or jump into https://pagure.io/fedora-join/Welcome-to-Fedora/issues['Welcome to Fedora'] activities.
// pboy: to add as soon as we have updated the site
// You may also check out link:++https://whatcanidoforfedora.org/++[whatcanidoforfedora] which will guide you to different areas where you can help, and to the people who can help you get started.
== How to help us and give you back a better working Fedora
The Fedora Documentation Project only actively maintains documentation for the most recent release and the one before it. We also preserve older documentation on this site for historical interest and to acknowledge the generous contribution of time and effort by many, many writers and translators.
=== Please help us to improve the documentation
We are always working to update and further improve this documentation. To do this, we rely on feedback. If you find errors, miss, or don't clearly understand a piece of specific information, or have suggestions for improvement, open an issue at our https://gitlab.com/fedora/docs/fedora-linux-documentation/release-docs-home/-/issues[documentation repository].
In the issue:
. Provide a summary of the error or your suggestion in the `Issue Title` field.
. Copy the following template into the `Comment` field and give us the details of the error or suggestion as specifically as you can. If possible, include some surrounding text so we know where the error occurs or the suggestion fits.
+
[subs="quotes"]
----
Document URL:
Section name:
Error or suggestion:
Additional information:
----
. Click the btn:[Create Issue] button.
We thank everybody who worked hard to correct that deficiency for previous versions of Fedora.

View file

@ -1,295 +0,0 @@
= Preparing Boot Media
The Fedora docs team
:revnumber: unknown
:revdate: currently slightly out of date
Fedora images are `Hybrid ISOs` and can be used to create installation media with both optical and USB disks, for booting on both BIOS and UEFI systems.
== Fedora Media Writer
[application]*Fedora Media Writer* has been significantly improved and is now the official, tested and supported way to make bootable media. [application]*Fedora Media Writer* supports Linux, macOS, and Windows. It is an easy way to make
bootable USB media to install Fedora (or other operating systems). Using [application]*Fedora Media Writer* is strongly encouraged, although other USB media creation software can work as well.
Some of the new additions to [application]*Fedora Media Writer* are that Fedora Workstation and Server are easily and quickly accessible from the selection on the main screen. Further choices are available if you select the button below _Custom image_. This offers a selection of various Fedora Spins, such as Xfce or Mate.
Historically, universal USB creation tools, such as [application]*Unetbootin*, are a popular way to create USB installers from ISOs intended for optical media. They typically create a filesystem on the USB drive by extracting files from the image, and writing [application]*syslinux* bootloader to the device.
These methods circumvent the boot-loader configuration built into Fedora images, which are pre-partitioned and designed to boot on UEFI systems with SecureBoot enabled as well as BIOS systems, and thus they do not produce consistent results with Fedora images, especially on UEFI systems.
The best results are produced by utilities that use a direct write method and do not modify the Fedora image.
[WARNING]
====
Always think twice before writing an image to the device. The media creation methods described in this article are destructive.
All data on the USB stick are deleted during the process, so make sure you have a back up of the data on the USB stick. Double check that you have selected correct device to write the image to!
====
=== Installing and running Fedora Media Writer
==== On Fedora
On Fedora 25 or later, [application]*Fedora Media Writer* is available in the default repository. You can use `dnf` to install the
package.
. To install the [application]*Fedora Media Writer* using:
+
[subs="quotes, macros, attributes"]
----
$ [command]#sudo dnf install mediawriter#
----
+
. Run the [application]*Fedora Media Writer*:
+
[subs="quotes, macros, attributes"]
----
$ [command]#mediawriter#
----
+
or in [application]*Gnome 3* select *Activities* and then click on [application]*Fedora Media Writer*.
==== On other Linux distributions
The best way to install [application]*Fedora Media Writer* on various Linux distributions is to use the pre-built _Flatpak_ package.
The package can be obtained from the official Flatpak repository https://flathub.org/apps/details/org.fedoraproject.MediaWriter[Flathub.org].
. To setup *Flatpak* on your Linux system, follow the guidelines on the https://flatpak.org/setup/[Flatpak documentation] page.
. Run the application:
+
[subs="quotes, macros, attributes"]
----
$ [command]#sudo mediawriter#
----
==== On Windows
. Download the latest Windows Installer file from link:++https://fedoraproject.org++[fedoraproject.org]. The server automatically detects the running system and offers you the correct installation file for your Windows version.
. Run the installation by double clicking the installer, and then continue through the set-up wizard. The Wizard lets you customize the software's installation if you choose to.
. Run the application by clicking on a launcher.
+
In Windows 8 and 10, the [application]*Fedora Media Writer* launcher will be placed in the _All apps_ menu under _F_. In Windows 10, you can just type [application]*Fedora Media Writer* in the search box on the task bar.
+
If you get an error about a missing .dll file (the MSVC redistributable), the needed library is freely available here: link:++https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist++[Microsoft Visual C++ Redistributable latest supported downloads].
==== On macOS
. Download the latest Macintosh Disk Image (the package will have a .dmg extension) from link:++https://fedoraproject.org++[fedoraproject.org]. The server automatically detects the running system and offers a correct package for your macOS.
. Open the `.dmg` file, and press and hold the kbd:[Ctrl] key while clicking on the [application]*Fedora Media Writer* application.
. Press "`Open`" in the pop-up menu.
. Click the "`Open`" button in the confirmation dialog, if it appears.
=== Writing the ISO image to the USB Media.
. Select the Fedora Edition you wish to make a bootable USB drive for.
+
[[figu-fedora_media_writer_choose_flavor_linux]]
.Fedora Media Writer Main Screen: Choose your Edition of Fedora
+
image::fedora_media_writer/FMW-select-image-source1.png[Image of Fedora Media Writer Main Screen]
+
The main selection lets you choose one of the default Fedora editions, Fedora *Workstation* or *Server*. [application]*Fedora Media Writer* displays more details about the edition before you can proceed with downloading the image and the USB creation. You can choose a different architecture, if you select _Other variants_.
. Select "`Create Live USB`" to proceed.
+
[[figu-fedora_media_writer_distro_information_fedora]]
.Fedora Media Writer Distro Information
+
image::fedora_media_writer/FMW-select-release-2.png[Image of Fedora Media Writer Distro Information Screen]
+
Fedora Media Writer will automatically download the ISO for you. If you have downloaded the ISO before and placed it in the _Downloads_ directory, it will be immediately available to use.
+
[[figu-fedora_media_writer_Automatic_download_fedora]]
.Fedora Media Writer Automatic Download
+
image::fedora_media_writer/FMW-download-options-3.png[Image of Fedora Media Writer Automatic Download]
. Plug in a USB drive on which you want to create the bootable media.
. To write the image onto the media, click the red btn:[Write to disk] button.
+
[[figu-fedora_media_writer_write_to_device_linux]]
.Fedora Media Writer Write to USB Device
+
image::fedora_media_writer/FMW-writing-5.png[Image of Fedora Media Writer write to device red button]
=== Other methods to create a live USB
Using the *Fedora Media Writer* is highly recommended for everybody, because it offers a reliable way to create a live USB stick for Fedora installation.
However, some experienced users may prefer to go through the creation process manually. If you decide to do so, you have to download the installation images and use an application to write them onto the USB stick.
[NOTE]
====
If you have downloaded and verified the installation images manually, you still can write them onto the USB stick using *Fedora Media Writer*.
====
[[sect-preparing-obtaining-images]]
==== Downloading Boot and Installation Images
The Fedora Project offers different Editions tailored for some specific use cases. Choose the Fedora Edition best for you. You can also build your own by customizing Fedora after it's installed or by using a kickstart file as described in _Creating a Kickstart File_.
//xref:advanced/Kickstart_Installations.adoc#sect-kickstart-file-create[Creating a Kickstart File].
Kickstart installation requires the `netinstall` media type, or a direct installation booting method such as PXE; kickstarts are not supported with live images.
Read more about Fedora Workstation, Fedora Cloud, Fedora Server and the available media types in _Downloading Fedora_.
//xref:Downloading_Fedora.adoc#chap-downloading-fedora[Downloading Fedora].
You can also choose a Fedora _Spin_ featuring favorite alternative desktops or tools for specialized tasks at link:++https://spins.fedoraproject.org++[].
[[sect-verifying-images]]
==== Verifying the Downloaded Image
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/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/++[] and the corresponding checksum file from link:++https://fedoraproject.org/security/++[]
. Open a [command]#powershell# session.
. Change to the directory containing the downloaded files.
+
[subs="macros"]
----
> cd $HOME\Downloads\
> ls
Directory: C:\Users\Pete\Downloads
Mode LastWriteTime Length Name
---- ------------- ------ ----
-a--- 11/25/2014 12:39 PM 272 Fedora-Server-21-x86_64-CHECKSUM
-a--- 11/25/2014 12:39 PM 2047868928 Fedora-Server-DVD-x86_64-21.iso
----
. Paste the following function to powershell for calculating and comparing checksums.
+
----
function Get-ImageVerification(){
param(
[Parameter(Mandatory=$true, Position=0)]
[string]$ImageFilePath,
[Parameter(Mandatory=$true, Position=1)]
[string]$ChecksumFilePath
)
$expected_checksum = ((Get-Content $ChecksumFilePath | Select-String -Pattern (Split-Path $ImageFilePath -leaf)) -split " ")[-1].ToLower()
$download_checksum = (Get-FileHash -Path $ImageFilePath -Algorithm SHA256).Hash.ToLower()
echo "Download Checksum: $download_checksum"
echo "Expected Checksum: $expected_checksum"
if ( $download_checksum -eq "$expected_checksum" ) {
echo "Checksum test passed!"
} else {
echo "Checksum test failed."
}
}
----
. Execute the function pasted in previous step
+
----
Get-ImageVerification .\Fedora-Server-DVD-x86_64-21.iso .\Fedora-Server-21-x86_64-CHECKSUM
----
[[sect-verifying-nix]]
==== Verifying checksums on Linux and macOS 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/security/++[]
. Open a terminal window, and navigate to the directory with the downloaded files.
+
[subs="quotes, macros, attributes"]
----
$ [command]#cd ~/Downloads#
----
. Use the appropriate utility to verify the image checksum.
+
** For Linux:
+
[subs="macros, attributes"]
----
$ sha256sum -c *CHECKSUM
----
+
** For macOS:
+
[subs="macros, attributes"]
----
$ grep '^SHA256' *-CHECKSUM | awk -F '[()=]' '{ print $4 " " $2 }' | shasum -a 256 -c
----
=== Writing the images to USB media
==== Creating USB media with [application]*GNOME Disks*
. On a system with [application]*GNOME*, or with the [package]*gnome-disk-utility* package installed, open `Disks` using the system menu.
. Click your USB device in the left column.
. Click the menu icon in the upper right corner of the window, and choose the `Restore Disk Image` option.
. Navigate to your image file and click `Start Restoring`. After a few minutes, it will report the process is complete and your installation media will be ready to use.
==== Creating USB Media on the Linux command line
. Open a terminal window and insert the usb drive.
. Find the `device node` assigned to the drive. In the example below, the drive is given `sdd`.
+
[subs="quotes, macros, attributes"]
----
$ [command]#dmesg|tail#
[288954.686557] usb 2-1.8: New USB device strings: Mfr=0, Product=1, SerialNumber=2
[288954.686559] usb 2-1.8: Product: USB Storage
[288954.686562] usb 2-1.8: SerialNumber: 000000009225
[288954.712590] usb-storage 2-1.8:1.0: USB Mass Storage device detected
[288954.712687] scsi host6: usb-storage 2-1.8:1.0
[288954.712809] usbcore: registered new interface driver usb-storage
[288954.716682] usbcore: registered new interface driver uas
[288955.717140] scsi 6:0:0:0: Direct-Access Generic STORAGE DEVICE 9228 PQ: 0 ANSI: 0
[288955.717745] sd 6:0:0:0: Attached scsi generic sg4 type 0
[288961.876382] sd 6:0:0:0: *sdd* Attached SCSI removable disk
----
. Use the [command]#dd# utility to write the image.
+
[subs="macros"]
----
# dd if=/path/to/Fedora-Live-Security-x86_64-21.iso of=/dev/sdd
----
+
[WARNING]
====
Pay extreme attention to the source (`if=`) and target (`of=`) device. The `dd` command destroys all data on the
target device. If you made a mistake, you could lose important data.
====
=== Creating a Boot CD or DVD
In addition to creating a bootable USB flash drive, you can also use the provided ISO images to create bootable optical media (a CD or DVD). This approach may be necessary when installing Fedora on an older system which cannot boot from USB.
[NOTE]
====
The exact steps you need to take to burn a bootable CD or DVD from an ISO image will vary depending on what disc burning software you use. This procedure only offers a general overview.
====
. Insert a blank CD or DVD into your system's CD or DVD burner.
. Open your system's burning software - for example, [application]*Brasero* on Fedora systems with [application]*GNOME* desktop environment, or [application]*Nero* on Windows systems. In the software's main menu, find an option which lets you burn an ISO image to a disc. For example, in [application]*Brasero*, this option is `Burn image` in the main menu on the left side of the window.
. When prompted, select the ISO image of Fedora to be burned, and the CD or DVD burner with a blank disc inside (if you have more than one drive).
. Confirm your selection, and wait for the disc to be burned.

View file

@ -1,35 +0,0 @@
= Upgrading Your Current System
The Fedora docs team
:revnumber: F39
:revdate: 2023-11-27
This chapter explains how to upgrade your existing Fedora installation to the current release.
There are two basic ways to do so:
Automatic upgrade using [application]*dnf system upgrade*::
The preferred way to upgrade your system is an automatic upgrade using the [application]*dnf system upgrade* utility.
For information on performing an automatic upgrade, see link: xref:quick-docs:ROOT:upgrading-fedora-offline.adoc[Upgrading Fedora using the DNF system upgrade plugin].
Manual Reinstallation::
Instead of relying on `dnf system upgrade`, you can _reinstall_ the latest version of Fedora.
This involves booting the installer as if you were performing a clean installation, letting it detect your existing Fedora system, and overwriting the root partition while preserving data on other partitions and volumes.
The same process can also be used to reinstall the system, if you need to do so for any reason.
For detailed information, see _Manual System Upgrade or Reinstallation_.
//xref:sect-upgrading-fedora-manual-reinstall[Manual System Upgrade or Reinstallation].
[IMPORTANT]
====
Always back up your data before performing an upgrade or reinstalling your system, no matter which method you choose.
====
[[sect-upgrading-fedora-manual-reinstall]]
== Manual System Upgrade or Reinstallation
Unfortunately, we have not written this chapter yet, and there is no dedicated documentation about a manual reinstall on the Wiki, either.
In the meantime before we fix this, you can try to start the installation normally (from a boot CD/DVD/USB), select manual partitioning in your installer, and reuse existing partitions instead of destroying them and creating new ones.
The instructions at _Manual Partitioning_ should in most cases be easy to adapt for this.
//xref:install/Installing_Using_Anaconda.adoc#sect-installation-gui-manual-partitioning[Manual Partitioning] should in most cases be easy to adapt for this.

View file

@ -1,4 +0,0 @@
:PREVVER: 43
:PRODVER: rawhide
:NEXTVER: 45
:YEAR: 2026

View file

@ -1,14 +0,0 @@
server {
listen 80;
server_name localhost;
location / {
root /antora/public;
index index.html index.htm;
}
error_page 500 502 503 504 /50x.html;
location = /50x.html {
root /usr/share/nginx/html;
}
}

View file

@ -1,31 +0,0 @@
site:
title: Local Preview
start_page: fedora::index.adoc
content:
sources:
- url: .
branches: HEAD
#- url: https://gitlab.com/fedora/docs/fedora-linux-documentation/install-guide.git
# branches:
# - main
#- url: https://gitlab.com/fedora/docs/fedora-linux-documentation/fedora-linux-sysadmin-guide.git
# branches:
# - main
- url: https://forge.fedoraproject.org/docs/release-notes.git
branches:
- main
- f44
- f43
ui:
bundle:
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
runtime:
fetch: true
cache_dir: ./cache
urls:
html_extension_style: indexify