Tirsvad
9cca29579f
TOKEN_FOR_GITEA_WIKI is an optional key, checked and masked but never used or asked for, so one .env can serve the wiki publishing too. GITHUB_PAT and GITHUB_USER are documented as required only when GitHub is chosen. The how-to for creating the access tokens moves from howto/ to the wiki as AccessTokens in English, Danish and Bahasa Malaysia, with its pictures in wiki/img/. README, Home and the sidebar link to it. Adds MIL-010 with its review RC-033 and the matching plan, user story and traceability rows. Task: MIL-010#1 Task: MIL-010#2 Task: MIL-010#3 Closes #83 Closes #84 Closes #85
29 lines
1.5 KiB
Markdown
29 lines
1.5 KiB
Markdown
English | [Dansk](SshAndTokens.da) | [Bahasa Melayu](SshAndTokens.ms)
|
|
|
|
# SSH and tokens
|
|
|
|
## SSH access to Gitea
|
|
|
|
The framework submodule is fetched over SSH on port **10022**. Before you run the script:
|
|
|
|
1. Add your SSH public key to your Gitea account.
|
|
2. Connect once by hand so the server's host key is known (the script refuses unknown host keys):
|
|
|
|
```bash
|
|
ssh -p 10022 -T git@git.tirsystem.com
|
|
```
|
|
|
|
A message that you have successfully authenticated, without shell access, means it works.
|
|
|
|
> **Passphrase keys.** The script never prompts for a passphrase. A key with a passphrase must already be loaded in `ssh-agent` (`ssh-add`). This is tracked in [issue 77](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/issues/77).
|
|
|
|
## Tokens
|
|
|
|
| Token | Key in `.env` | Needed | Type |
|
|
| --- | --- | --- | --- |
|
|
| Gitea access token | `GITEA_TOKEN` | always | access token with scopes |
|
|
| GitHub personal access token | `GITHUB_PAT` | required when you choose GitHub (the mirror) | **classic** personal access token |
|
|
| Gitea access token for the wiki | `TOKEN_FOR_GITEA_WIKI` | optional (only to publish the wiki) | access token with the repository write scope (`write:repository`) only; the script accepts it but never uses it |
|
|
|
|
Step by step with pictures: [how to create the access tokens](AccessTokens). The exact permissions are under [Token permissions](https://git.tirsystem.com/TirSystem-BashScript/repo-foundry/src/branch/main/README.md#token-permissions) in the README.
|