From 2994d22636d61c7162e00685731e1781cfde75ba Mon Sep 17 00:00:00 2001 From: ngn Date: Fri, 12 Jan 2024 14:37:13 +0300 Subject: [PATCH] Added mirror page --- wiki/main.md | 4 ++-- wiki/mirrors.json | 6 ++++++ wiki/mirrors.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ wiki/repo.md | 4 ++-- 4 files changed, 55 insertions(+), 4 deletions(-) create mode 100644 wiki/mirrors.json create mode 100644 wiki/mirrors.md diff --git a/wiki/main.md b/wiki/main.md index 9535370..ebc1552 100644 --- a/wiki/main.md +++ b/wiki/main.md @@ -9,7 +9,7 @@ don't have a link yet. | --------------------------- | ----------------------------------------------- | | Introduction | Learn about MatterLinux and other general stuff | | Installation | Learn how to install a base MatterLinux system | -| Installation (Any% Edition) | TLDR for the Installation page | +| Installation (Any% Edition) | Speedrunner edition of the Installation page | | Post-Installation | Make your system (somewhat) usable | ## Packaging @@ -18,7 +18,7 @@ don't have a link yet. | [Repo](wiki/repo) | Learn about MatterLinux repos and how they work | | [Package](wiki/package) | Learn about MatterLinux packages | | [Package Management](wiki/package_man) | Learn about MatterLinux package manager | -| Mirrors | Discover repo mirrors and learn how you can setup one | +| [Mirrors](wiki/mirrors) | Discover repo mirrors and learn how you can setup one | ## Other | Name | Description | diff --git a/wiki/mirrors.json b/wiki/mirrors.json new file mode 100644 index 0000000..2190600 --- /dev/null +++ b/wiki/mirrors.json @@ -0,0 +1,6 @@ +{ + "id": "mirrors", + "title": "Mirrors", + "author": "ngn", + "date": "12/01/24" +} diff --git a/wiki/mirrors.md b/wiki/mirrors.md new file mode 100644 index 0000000..924fa70 --- /dev/null +++ b/wiki/mirrors.md @@ -0,0 +1,45 @@ +Mirrors are web and FTP servers that mirror repos from the official repo web server. + +# Usage +To use a mirror with `mp`, change the repo URI for the target repo in your `mp` +configuration file (`/etc/mp/cfg`). + +### Creating a mirror +To create a mirror you can use the `matter-mirror` tool. This tool is included +with the `matter-tools` repository. To install it [see the project READMDE](https://git.matterlinux.xyz/Matter/matter-tools#installation). + +After installing `matter-mirror`, specify an URI and an output directory (files will be downloaded +into the output directory). For example to mirror the `base` repo from +`https://pkgs.matterlinux.xyz/base` to `base_mirror` directory: +``` +$ mkdir base_mirror +$ matter-mirror -u https://pkgs.matterlinux.xyz/base -o base_mirror +``` + +To serve the mirror, you can setup a web server such as `nginx`, or you can setup a FTP +server such as `pure-ftpd`. + +You will mostly likely want to update your mirror every once in a while. To do so you can +create a cron job. For example to update your mirror every day at 00:00, you can add the +following entry to your `/etc/crontab`: +``` +0 0 * * * matter-mirror -u -o +``` + +# List +This section contains information about different MatterLinux repo and mirros +that you can use. To add your mirror to this list get in contact with the maintainer/developers. + +Note that official mirrors are **ALWAYS** signed with the `F9E70878C2FB389AEC2BA34CA3654DF5AD9F641D` +fingerprint (belongs to the maintainer, ngn). If syncing with a mirror tells you otherwise, then +**DO NOT USE THAT MIRROR** and report it to the maintainer/developers in order to remove it +from the list. + +### Official repos +| Repo | URI | Location | +| ------- | -------------------------------------- | ----------- | +| base | `https://pkgs.matterlinux.xyz/base` | 🇹🇷 Turkey | +| desktop | `https://pkgs.matterlinux.xyz/desktop` | 🇹🇷 Turkey | + +### Mirrors +Currently there are no available mirrors. diff --git a/wiki/repo.md b/wiki/repo.md index 5024422..ec1abaa 100644 --- a/wiki/repo.md +++ b/wiki/repo.md @@ -96,13 +96,13 @@ used for building MatterLinux repos. To do so please follow the steps [here](htt Finally to build the repo: ``` -mp-repo +$ mp-repo ``` You will mostly likely want to disable package signing though, as you are probably not the owner of the repo: ``` -mp-repo --no-sign +$ mp-repo --no-sign ``` ### Creating a new repo