Skip to content

Commit

Permalink
rocky-linux#1867 fix markdown violation in guides
Browse files Browse the repository at this point in the history
  • Loading branch information
nishaaaaaant committed Apr 4, 2024
1 parent c14dd67 commit 54ec20a
Show file tree
Hide file tree
Showing 21 changed files with 503 additions and 503 deletions.
6 changes: 3 additions & 3 deletions docs/guides/email/01-email-system.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,14 +61,14 @@ As shown in the picture below, this is a simple illustration of the sending and

For more information about postfix, please refer to these two links:

* [GitHub repository](https://github.com/vdukhovni/postfix)
* [Official website](http://www.postfix.org/)
- [GitHub repository](https://github.com/vdukhovni/postfix)
- [Official website](http://www.postfix.org/)

### The process of sending emails by the client

![legend01](./email-images/email-system02.jpg)

Postfix determines whether an email sent from a client belongs to the local or external domain. The email will be stored in the local domain mailbox if it belongs to the local domain. If the email sent belongs to an external domain, it is forwarded to another MTA (the user's identity needs to be verified from the database before forwarding).
Postfix determines whether an email sent from a client belongs to the local or external domain. The email will be stored in the local domain mailbox if it belongs to the local domain. If the email sent belongs to an external domain, it is forwarded to another MTA (the user's identity needs to be verified from the database before forwarding).

### The process of receiving emails by the client

Expand Down
11 changes: 8 additions & 3 deletions docs/guides/interoperability/import_rocky_to_wsl.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ tags:
The Windows-Subsystem for Linux feature has to be enabled. This is possible with one of these options:

- Since very shortly there is now [a new WSL version available in the Microsoft Store](https://apps.microsoft.com/store/detail/windows-subsystem-for-linux/9P9TQF7MRM4R), which has more features use this if possible
- Open an administrative Terminal (either PowerShell or Command-Prompt) and<br>run `wsl --install` ([ref.](https://docs.microsoft.com/en-us/windows/wsl/install))
- Open an administrative Terminal (either PowerShell or Command-Prompt) and
run `wsl --install` ([ref.](https://docs.microsoft.com/en-us/windows/wsl/install))
- Go to the graphical Windows Settings and enable the optional feature `Windows-Subsystem for Linux`

This feature should be available on every supported Windows 10 and 11 version right now.
Expand All @@ -26,8 +27,12 @@ This feature should be available on every supported Windows 10 and 11 version ri
1. Get the container rootfs. This is possible in multiple ways:

- **Prefered:** Download the image from the CDN:
- 8: [Base x86_64](https://dl.rockylinux.org/pub/rocky/8/images/x86_64/Rocky-8-Container-Base.latest.x86_64.tar.xz), [Minimal x86_64](https://dl.rockylinux.org/pub/rocky/8/images/x86_64/Rocky-8-Container-Minimal.latest.x86_64.tar.xz), [UBI x86_64](https://dl.rockylinux.org/pub/rocky/8/images/x86_64/Rocky-8-Container-UBI.latest.x86_64.tar.xz),<br>[Base aarch64](https://dl.rockylinux.org/pub/rocky/8/images/aarch64/Rocky-8-Container-Base.latest.aarch64.tar.xz), [Minimal aarch64](https://dl.rockylinux.org/pub/rocky/8/images/aarch64/Rocky-8-Container-Minimal.latest.aarch64.tar.xz), [UBI aarch64](https://dl.rockylinux.org/pub/rocky/8/images/aarch64/Rocky-8-Container-UBI.latest.aarch64.tar.xz)
- 9: [Base x86_64](https://dl.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-Container-Base.latest.x86_64.tar.xz), [Minimal x86_64](https://dl.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-Container-Minimal.latest.x86_64.tar.xz), [UBI x86_64](https://dl.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-Container-UBI.latest.x86_64.tar.xz),<br>[Base aarch64](https://dl.rockylinux.org/pub/rocky/9/images/aarch64/Rocky-9-Container-Base.latest.aarch64.tar.xz), [Minimal aarch64](https://dl.rockylinux.org/pub/rocky/9/images/aarch64/Rocky-9-Container-Minimal.latest.aarch64.tar.xz), [UBI aarch64](https://dl.rockylinux.org/pub/rocky/9/images/aarch64/Rocky-9-Container-UBI.latest.aarch64.tar.xz)
- 8: [Base x86_64](https://dl.rockylinux.org/pub/rocky/8/images/x86_64/Rocky-8-Container-Base.latest.x86_64.tar.xz), [Minimal x86_64](https://dl.rockylinux.org/pub/rocky/8/images/x86_64/Rocky-8-Container-Minimal.latest.x86_64.tar.xz), [UBI x86_64](https://dl.rockylinux.org/pub/rocky/8/images/x86_64/Rocky-8-Container-UBI.latest.x86_64.tar.xz),

[Base aarch64](https://dl.rockylinux.org/pub/rocky/8/images/aarch64/Rocky-8-Container-Base.latest.aarch64.tar.xz), [Minimal aarch64](https://dl.rockylinux.org/pub/rocky/8/images/aarch64/Rocky-8-Container-Minimal.latest.aarch64.tar.xz), [UBI aarch64](https://dl.rockylinux.org/pub/rocky/8/images/aarch64/Rocky-8-Container-UBI.latest.aarch64.tar.xz)
- 9: [Base x86_64](https://dl.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-Container-Base.latest.x86_64.tar.xz), [Minimal x86_64](https://dl.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-Container-Minimal.latest.x86_64.tar.xz), [UBI x86_64](https://dl.rockylinux.org/pub/rocky/9/images/x86_64/Rocky-9-Container-UBI.latest.x86_64.tar.xz),

[Base aarch64](https://dl.rockylinux.org/pub/rocky/9/images/aarch64/Rocky-9-Container-Base.latest.aarch64.tar.xz), [Minimal aarch64](https://dl.rockylinux.org/pub/rocky/9/images/aarch64/Rocky-9-Container-Minimal.latest.aarch64.tar.xz), [UBI aarch64](https://dl.rockylinux.org/pub/rocky/9/images/aarch64/Rocky-9-Container-UBI.latest.aarch64.tar.xz)
- Extract the image from either Docker Hub or Quay.io ([ref.](https://docs.microsoft.com/en-us/windows/wsl/use-custom-distro#export-the-tar-from-a-container))

```sh
Expand Down
70 changes: 36 additions & 34 deletions docs/guides/mirror_management/add_mirror_manager.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ We always welcome new public mirrors. But they should be well maintained and hos

Please do not submit mirrors hosted in an Anycast-CDN like Cloudflare, etc., as this can lead to sub-optimal performance with selecting the fastest mirror in `dnf`.

Please note that we cannot accept public mirrors in countries subject to US export regulations. You can find a list of those countries here: [https://www.bis.doc.gov/index.php/policy-guidance/country-guidance/sanctioned-destinations](https://www.bis.doc.gov/index.php/policy-guidance/country-guidance/sanctioned-destinations)
Please note that we cannot accept public mirrors in countries subject to US export regulations. You can find a list of those countries here: <https://www.bis.doc.gov/index.php/policy-guidance/country-guidance/sanctioned-destinations>

As of this writing (late 2022), storage space requirements for mirroring all current and past Rocky Linux releases is about 2 TB.

Expand All @@ -26,7 +26,7 @@ Please set up a cron job to synchronize your mirror periodically and let it run

Here are some crontab examples for you:

```
```bash
#This will synchronize your mirror at 0:50, 4:50, 8:50, 12:50, 16:50, 20:50
50 */6 * * * /path/to/your/rocky-rsync-mirror.sh > /dev/null 2>&1

Expand All @@ -40,41 +40,43 @@ Here are some crontab examples for you:

For a simple synchronization you can use the following `rsync` command:

```
```bash
rsync -aqH --delete source-mirror destination-dir
```

Consider using a locking mechanism to avoid running multiple `rsync` job simultaneously when we push a new release.

You can also use and modify our example script implementing locking and full sync if required. It can be found at [https://github.com/rocky-linux/rocky-tools/blob/main/mirror/mirrorsync.sh](https://github.com/rocky-linux/rocky-tools/blob/main/mirror/mirrorsync.sh).
You can also use and modify our example script implementing locking and full sync if required. It can be found at <https://github.com/rocky-linux/rocky-tools/blob/main/mirror/mirrorsync.sh>.

After your first complete synchronization check that everything is fine with your mirror. Most importantly check all files and dirs got synchronized, your cron job is working properly and your mirror is reachable from the public Internet. Double check your firewall rules! To avoid any problems do not enforce http to https redirection.

If you have any questions setting up your mirror join https://chat.rockylinux.org/rocky-linux/channels/infrastructure
If you have any questions setting up your mirror join <https://chat.rockylinux.org/rocky-linux/channels/infrastructure>

When you are done head over to the next section and propose your mirror to become public!

## What You Need
* An account on https://accounts.rockylinux.org/

- An account on <https://accounts.rockylinux.org/>

## Creating a site

Rocky uses Fedora's Mirror Manager for organizing community mirrors.

Access Rocky's Mirror Manager here: https://mirrors.rockylinux.org/mirrormanager/
Access Rocky's Mirror Manager here: <https://mirrors.rockylinux.org/mirrormanager/>

After a successful login, your profile will be on the top right. Select the drop down then click "My sites".

A new page will load listing all sites under the account. The first time it will be empty. Click "Register a new site".

A new page will load with an important Export Compliance statement to read. Then fill out the following information:

* "Site Name"
* "Site Password" - used by `report_mirrors` script, you make this anything you want
* "Organization URL" - Company/School/Organization URL e.g. https://rockylinux.org/
* "Private" - Checking this box hides your mirror from public use.
* "User active" - Uncheck this box to temporarily disable this site, it will be removed from public listings.
* "All sites can pull from me?" - Enable all mirror sites to pull from me without explicitly adding them to my list.
* "Comments for downstream siteadmins. Please include your synchronization source here to avoid dependency loops."
- "Site Name"
- "Site Password" - used by `report_mirrors` script, you make this anything you want
- "Organization URL" - Company/School/Organization URL e.g. <https://rockylinux.org/>
- "Private" - Checking this box hides your mirror from public use.
- "User active" - Uncheck this box to temporarily disable this site, it will be removed from public listings.
- "All sites can pull from me?" - Enable all mirror sites to pull from me without explicitly adding them to my list.
- "Comments for downstream siteadmins. Please include your synchronization source here to avoid dependency loops."

Upon clicking "Submit" you will be returned to the main mirror page.

Expand All @@ -90,46 +92,46 @@ All of the options from the last section are listed again. At the bottom of the

Fill out the following options that are appropriate for the site:

* "Host name" - required: FQDN of server as seen by a public end user
* "User active" - Uncheck this box to temporarily disable this host, it will be removed from public listings.
* "Country" - required: 2-letter ISO country code
* "Bandwidth" - required: integer megabits/sec, how much bandwidth this host can serve
* "Private" - e.g. not available to the public, an internal private mirror
* "Internet2" - on Internet2
* "Internet2 clients" - serves Internet2 clients, even if private
* "ASN" - Autonomous System Number, used in BGP routing tables. Only if you are an ISP.
* "ASN Clients" - Serve all clients from the same ASN. Used for ISPs, companies, or schools, not personal networks.
* "Robot email" - email address, will receive notice of upstream content updates
* "Comment" - text, anything else you'd like a public end user to know about your mirror
* "Max connections" - Maximum parallel download connections per client, suggested via metalinks.
- "Host name" - required: FQDN of server as seen by a public end user
- "User active" - Uncheck this box to temporarily disable this host, it will be removed from public listings.
- "Country" - required: 2-letter ISO country code
- "Bandwidth" - required: integer megabits/sec, how much bandwidth this host can serve
- "Private" - e.g. not available to the public, an internal private mirror
- "Internet2" - on Internet2
- "Internet2 clients" - serves Internet2 clients, even if private
- "ASN" - Autonomous System Number, used in BGP routing tables. Only if you are an ISP.
- "ASN Clients" - Serve all clients from the same ASN. Used for ISPs, companies, or schools, not personal networks.
- "Robot email" - email address, will receive notice of upstream content updates
- "Comment" - text, anything else you'd like a public end user to know about your mirror
- "Max connections" - Maximum parallel download connections per client, suggested via metalinks.

Click "Create" and it will redirect back to the Information site for the host.

## Update host

At the bottom of the Information site, the option for "Hosts" should now display the host title next to it. Click on the name to load the host page. All of the same options from the previous step are listed again. There are new options at the bottom.

* "Site-local Netblocks": Netblocks are used to try to guide and end user to a site-specific mirror. For example, a university might list their netblocks, and the mirrorlist CGI would return the university-local mirror rather than a country-local mirror. Format is one of 18.0.0.0/255.0.0.0, 18.0.0.0/8, an IPv6 prefix/length, or a DNS hostname. Values must be public IP addresses (no RFC1918 private space addresses). Use only if you are an ISP and/or own a publicly routable netblock!
- "Site-local Netblocks": Netblocks are used to try to guide and end user to a site-specific mirror. For example, a university might list their netblocks, and the mirrorlist CGI would return the university-local mirror rather than a country-local mirror. Format is one of 18.0.0.0/255.0.0.0, 18.0.0.0/8, an IPv6 prefix/length, or a DNS hostname. Values must be public IP addresses (no RFC1918 private space addresses). Use only if you are an ISP and/or own a publicly routable netblock!

* "Peer ASNs": Peer ASNs are used to guide an end user on nearby networks to our mirror. For example, a university might list their peer ASNs, and the mirrorlist CGI would return the university-local mirror rather than a country-local mirror. You must be in the MirrorManager administrators group in order to create new entries here.
- "Peer ASNs": Peer ASNs are used to guide an end user on nearby networks to our mirror. For example, a university might list their peer ASNs, and the mirrorlist CGI would return the university-local mirror rather than a country-local mirror. You must be in the MirrorManager administrators group in order to create new entries here.

* "Countries Allowed": Some mirrors need to restrict themselves to serving only end users from their country. If you're one of these, list the 2-letter ISO code for the countries you will allow end users to be from. The mirrorlist CGI will honor this.
- "Countries Allowed": Some mirrors need to restrict themselves to serving only end users from their country. If you're one of these, list the 2-letter ISO code for the countries you will allow end users to be from. The mirrorlist CGI will honor this.

* "Categories Carried": Hosts carry categories of software. Example Fedora categories include Fedora and Fedora Archive.
- "Categories Carried": Hosts carry categories of software. Example Fedora categories include Fedora and Fedora Archive.

Click on the "[add]" link under "Categories Carried".

### Categories Carried

For the Category, select "Rocky Linux" then "Create" to load the URL page. Then click "[add]" to load the "Add host category URL" page. There is one option. Repeat as needed for each of the mirrors supported protocols.

* "URL" - URL (rsync, https, http) pointing to the top directory
- "URL" - URL (rsync, https, http) pointing to the top directory

Examples:
* `http://rocky.example.com`
* `https://rocky.example.com`
* `rsync://rocky.example.com`

- `http://rocky.example.com`
- `https://rocky.example.com`
- `rsync://rocky.example.com`

## Wrap up

Expand Down
Loading

0 comments on commit 54ec20a

Please sign in to comment.