]> git.ipfire.org Git - thirdparty/FORT-validator.git/commitdiff
Remove traces of the master branch from the doc
authorAlberto Leiva Popper <ydahhrk@gmail.com>
Wed, 28 Dec 2022 23:15:37 +0000 (17:15 -0600)
committerAlberto Leiva Popper <ydahhrk@gmail.com>
Wed, 28 Dec 2022 23:15:37 +0000 (17:15 -0600)
The "master" branch was renamed to "main" a short while ago.

docker/README.md
docs/installation.md
docs/usage.md
fort_setup.sh [deleted file]

index 7eaf54b15d71fe5c84871e3da412824f109e5293..da620ce7f27eb84c38a962ee341db82a2064bc38 100644 (file)
@@ -4,7 +4,7 @@ Docker image for [NICMx/FORT-validator](https://github.com/NICMx/FORT-validator)
 
 Special thanks to [ximon18](https://github.com/ximon18) for its [contribution](https://github.com/NICMx/FORT-validator/issues/17).
 
-**This image doesn't include TAL (Trust Anchor Locator) files.** They must be obtained somewhere else (here's [an example](https://github.com/NICMx/FORT-validator/tree/master/examples/tal)).
+**This image doesn't include TAL (Trust Anchor Locator) files.** They must be obtained somewhere else (here's [an example](https://github.com/NICMx/FORT-validator/tree/main/examples/tal)).
 
 To pull the official docker image, run:
 
index 9407ec35fbaf93a5445314e8b4e787f6bec66906..57f7c7ade80b24b100a865ea5b62ab8cdc6d5ec9 100644 (file)
@@ -439,7 +439,7 @@ sudo make install
 
 ## Option 4: Running from a Docker container
 
-There's also the option to run FORT validator from a Docker container. The image can be pulled from [Docker Hub](https://hub.docker.com/r/nicmx/fort-validator) or built from the official Github repository: [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker).
+There's also the option to run FORT validator from a Docker container. The image can be pulled from [Docker Hub](https://hub.docker.com/r/nicmx/fort-validator) or built from the official Github repository: [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/main/docker).
 
 To pull the image from the official repository, run:
 
@@ -459,7 +459,7 @@ A basic example to run the container using the default values, reading from a lo
 docker run --name fort-validator -v host/path/to/tals:/etc/fort/tal:ro -p 8323:323 -d fort-validator
 {% endhighlight %}
 
-Read more about the Docker container at the Github repository [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/master/docker).
+Read more about the Docker container at the Github repository [FORT-validator/docker](https://github.com/NICMx/FORT-validator/tree/main/docker).
 
 ## Fetching the TALs
 
index 967444e22c785153c8986ee1560549e4faa7c43c..6f3e193dc2f68650d2ffd43cb747249c1846f753 100644 (file)
@@ -1315,16 +1315,16 @@ This is a JSON array of objects, where each object has a mandatory `url` member,
                "accept-message": "Please download and read ARIN Relying Party Agreement (RPA) from https://www.arin.net/resources/manage/rpki/rpa.pdf. Once you've read it and if you agree ARIN RPA, type 'yes' to proceed with ARIN's TAL download:"
        },
        {
-               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/master/examples/tal/lacnic.tal"
+               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/main/examples/tal/lacnic.tal"
        },
        {
-               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/master/examples/tal/ripe.tal"
+               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/main/examples/tal/ripe-ncc.tal"
        },
        {
-               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/master/examples/tal/afrinic.tal"
+               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/main/examples/tal/afrinic.tal"
        },
        {
-               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/master/examples/tal/apnic.tal"
+               "url": "https://raw.githubusercontent.com/NICMx/FORT-validator/main/examples/tal/apnic.tal"
        }
 ]
 ```
diff --git a/fort_setup.sh b/fort_setup.sh
deleted file mode 100755 (executable)
index 4cb1ff8..0000000
+++ /dev/null
@@ -1,168 +0,0 @@
-#!/bin/sh
-
-# Setup script to ease FORT validator configuration (or even another RP),
-# expects one arg:
-#   $ ./fort_setup.sh TALS_PATH
-#
-# ADVISE: Preferably, run this script with the same user what will run FORT
-# validator. It's recommended that the user has write permission in /var/cache,
-# since the script will try to create a directory there (see
-# https://refspecs.linuxfoundation.org/FHS_3.0/fhs/ch05s05.html).
-# 
-# TALS_PATH must be an existent directory path, where the five RIRs TALs will
-# be downloaded.
-#
-# The main objective of this script is to simplify ARIN TAL download, by
-# explicitly agreeing its RPA. The rest of the actions are just facilitators to
-# run FORT validator.
-#
-# The script does the following:
-# 1. Display message to agree ARIN RPA.
-# 2. If agreed, download ARIN TAL to TALS_PATH arg.
-# 3. Download the rest of the TALs to TALS_PATH arg.
-# 4. Try to create directory '/var/cache/fort/repository', on error create
-#    '/tmp/fort/repository'.
-# 5. Create configuration file with 'tal' and 'local-repository' members,
-#    with a value of TALS_PATH (absolute path) and the directory path created
-#    at the previous step.
-# 6. Display FORT validator execution examples:
-#    - Using the created configuration file (uses the arg '-f').
-#    - Using the values of the configuration file (uses the args '--tal' and
-#      '--local-repository').
-
-echo "WARNING: this script (fort_setup.sh) is deprecated, and will be deleted soon."
-echo "I don't even know if it works properly."
-echo "If you want to download the TALs, use the fort binary's --init-tals option."
-echo "See https://nicmx.github.io/FORT-validator/usage.html#--init-tals"
-echo "===================================="
-
-exit_on_err()
-{
-  if ! [ $1 ] ; then
-    echo "$2"
-    exit 1
-  fi
-}
-
-# Timeout for http requests
-DOWN_TIME=20
-
-get_tal()
-{
-  echo ""
-  echo "Fetching $1 TAL..."
-  wget -O "$2" -T $DOWN_TIME $3
-  RES=$?
-  exit_on_err "\"$RES\" = \"0\"" "Couldn't fetch $1 TAL, try again."
-}
-
-# Validate expected args
-exit_on_err "$# -gt 0" 'Usage: '"$0"' TALS_PATH.\nTALS_PATH must be an existent directory path.'
-TMP=`echo "$1"`
-if ! [ -d "$TMP" ] ; then
-  echo "Path '$TMP' isn't a directory."
-  exit 1
-fi
-if ! [ -w "$TMP" ] ; then
-  echo "Write permission denied on path '$TMP'."
-  exit 1
-fi
-
-# Define download command
-if type wget >/dev/null 2>&1 ; then
-  echo ""
-else
-  echo "Couldn't find 'wget' program; I need it to fetch the TALs."
-  exit 1
-fi
-
-# Get the absolute path, in case the configuration file is placed elsewhere
-TALS_LOC=$TMP
-TMP=$(readlink -f "$TALS_LOC")
-if [ "$?" = "0" ] ; then
-  TALS_LOC="$TMP"
-  TMP=""
-fi
-
-# Get the configuration directory
-CONF_DIR="$(dirname "${TALS_LOC}")"
-if [ ! -w "${CONF_DIR}" ]; then
-  CONF_DIR="/tmp/fort"
-  if [ ! -d "${CONF_DIR}" ]; then
-    mkdir -p "${CONF_DIR}"
-  fi
-fi
-
-# Declare variables
-GITHUB_TALS="https://raw.githubusercontent.com/NICMx/FORT-validator/master/examples/tal"
-ACCEPT="no"
-REPO_DIR="/var/cache/fort/repository"
-CONF_FILE="${CONF_DIR}/fort-config.json"
-ARIN_TAL="https://www.arin.net/resources/manage/rpki/arin.tal"
-
-# Agree ARIN RPA. Exit on denial or unknown response, download otherwise.
-echo "Please download and read ARIN Relying Party Agreement (RPA) from https://www.arin.net/resources/manage/rpki/rpa.pdf"
-echo ""
-echo -n "Once you've read and if you agree ARIN RPA, type \"yes\" to proceed with ARIN's TAL download: "
-read ACCEPT
-exit_on_err "\"$(echo $ACCEPT | tr '[:upper:]' '[:lower:]')\" = \"yes\"" '\nYou haven'"'"'t agreed ARIN RPA! You can manually download its TAL or try running this script again.\n\nWe strongly advise to download ARIN TAL so that the Relying Party (validator) can validate the whole RPKI.'
-
-get_tal "ARIN" "$TALS_LOC/arin.tal" $ARIN_TAL
-
-# Get the rest of the TALs
-echo ""
-echo "Fetching the rest of the TALs"
-get_tal "LACNIC" "$TALS_LOC/lacnic.tal" "$GITHUB_TALS/lacnic.tal"
-get_tal "RIPE" "$TALS_LOC/ripe-ncc.tal" "$GITHUB_TALS/ripe-ncc.tal"
-get_tal "AFRINIC" "$TALS_LOC/afrinic.tal" "$GITHUB_TALS/afrinic.tal"
-get_tal "APNIC" "$TALS_LOC/apnic.tal" "$GITHUB_TALS/apnic.tal"
-
-# Try to create local repository directory
-mkdir -p -v $REPO_DIR
-if ! [ "$?" = "0" ] ; then
-  echo "Couldn't create dir $REPO_DIR."
-  REPO_DIR="/tmp/fort/repository"
-  echo ""
-  echo "Fallback, trying to create dir $REPO_DIR."
-  mkdir -p -v $REPO_DIR
-  if ! [ "$?" = "0" ] ; then
-    echo "Couldn't create dir $REPO_DIR."
-    REPO_DIR=""
-  fi
-fi
-
-# Create or overwrite configuration file
-touch $CONF_FILE
-echo "{ " > $CONF_FILE
-if ! [ -z "$REPO_DIR" ] ; then
-  echo "  \"local-repository\": \"$REPO_DIR\"," >> $CONF_FILE
-fi
-echo "  \"tal\": \"$TALS_LOC\"" >> $CONF_FILE
-echo "} " >> $CONF_FILE
-
-# Display actions summary and usage examples
-echo ""
-echo "------------------------------------------------------"
-if [ -z "$TMP" ] ; then
-  echo "--------------------   Success!   --------------------"
-else
-  echo "-------------   Done (with warnings)!   --------------"
-fi
-echo "------------------------------------------------------"
-echo ""
-echo "- The five RIRs TAL's were downloaded to '$TALS_LOC'."
-if ! [ -z "$REPO_DIR" ] ; then
-  echo "- The directory $REPO_DIR was created, so it can be used as the local repository."
-fi
-if ! [ -z "$TMP" ] ; then
-  echo "- WARNING! Couldn't get absolute path of '$TALS_LOC', so I utilized this path '$TALS_LOC' at the configuration file"
-fi
-echo "- The configuration file '$CONF_FILE' was created with the following content:"
-cat $CONF_FILE
-echo ""
-echo "- This configuration file can be utilized with FORT validator, e.g.:"
-echo "  \$ fort -f \"$CONF_FILE\""
-echo "- Or its members can be utilized as FORT validator arguments, e.g.:"
-echo -n "  \$ fort --tal \"$TALS_LOC\"" && ! [ -z "$REPO_DIR" ] && echo " --local-repository \"$REPO_DIR\""
-echo "" 
-