Commit a1429108 authored by Oliver Horst's avatar Oliver Horst
Browse files

[chg] Adjusted documentation for open source release of toki

parent 2d230700
......@@ -75,17 +75,17 @@ $ sudo chmod a+rx /usr/local/bin/repo
#### Install toki
To prepare the installation of toki you need to obtain a personal access token from GitLab with at least 'api' and 'read_repository' access rights. This token is needed in the following steps of the setup process and referred to as ``<PRIVATE_TOKEN>``.
The actual installation of the toki build- and test-environment is conducted by an automatic setup script. Please download and execute the script by executing the following command:
```bash
$ bash <(curl -s --request GET --header 'PRIVATE-TOKEN: <PRIVATE_TOKEN>' 'https://git.fortiss.org/api/v4/projects/1245/repository/files/scripts%2Ftoki-setup/raw?ref=master') --token <PRIVATE_TOKEN> <INSTALLATION_DIR>
$ bash <(curl -s 'https://git.fortiss.org/api/v4/projects/1245/repository/files/scripts%2Ftoki-setup/raw?ref=master') [OPTIONS] <INSTALLATION_DIR>
```
This command also accepts ``--manifest-branch <MANIFEST_BRANCH>`` as parameter to indicate a certain toki manifest branch you would like to work with. A list of valid manifest branches can be obtained with the following command:
```bash
$ git ls-remote --tags --heads https://git.fortiss.org/toki/manifests 2>/dev/null | awk '!/.*\^\{\}$/' | awk 'match($0, /refs\/heads\/(.*)$/, head) { print head[1] } match($0, /(refs\/tags\/.*)$/, tag) { print tag[1] }'
```
As ``[OPTIONS]`` the ``toki-setup`` command accepts:
* ``--manifest-branch <MANIFEST_BRANCH>`` to indicate a certain toki manifest branch you would like to work with. A list of valid manifest branches can be obtained with the following command:
```bash
$ git ls-remote --tags --heads https://git.fortiss.org/toki/manifests 2>/dev/null | awk '!/.*\^\{\}$/' | awk 'match($0, /refs\/heads\/(.*)$/, head) { print head[1] } match($0, /(refs\/tags\/.*)$/, tag) { print tag[1] }'
```
* ``--token <PRIVATE_TOKEN>`` to indicate a GitLab personal access token. You will need this token to contribute to toki. Please contact [Oliver Horst](mailto:horst@fortiss.org) at fortiss, if you are interested in a fortiss GitLab contributor account.
The toki setup script will download and install the toki build- and test-environment within the ``<INSTALLATION_DIR>`` you have specified on the command line. Please ensure that the folder is empty or not yet existing. The setup script will guide you through the rest of the installation. Please note that the script will store your provided ``<PRIVATE_TOKEN>`` within the file '.git-credentials' in the ``<INSTALLATION_DIR>``. This file is stored with a umask of 0077 to ensure your privacy and used as credential helper for Git to simplify your future accesses to the toki repositories.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment