improve documentation about GitHub tokens

This commit is contained in:
RayBB 2025-01-07 17:40:01 -05:00 committed by Johannes Millan
parent 815cb5effc
commit 82383740ef
7 changed files with 23 additions and 13 deletions

View file

@ -68,7 +68,7 @@ We also need to save any incomplete syncs, so that we can warn the user if closi
- try to download new archive file
- (reattempt once if checksum check still fails (remote update might not be completed yet???))
- (if checksum check still fails, check once for new main file (via etag))
- if any of the downloads fail show error message that sync couldnt be completed and ask if the user wants to try again
- if any of the downloads fail show error message that sync couldn't be completed and ask if the user wants to try again
- if checksum check still fails after successful download, show error message and ask if local data should be used instead and if remote data should be overwritten
-

View file

@ -1,17 +1,27 @@
# Howto generate a Access Token with Privilegs
# How to generate an Access Token with Privileges
## Personal Access Token
For polling Gitlab Issues you need to provide a access Token.
## GitLab Personal Access Token
For polling GitLab Issues, you need to provide an access token.
1. Got to User Settings / Access tokens (On Github you can go [here](https://github.com/settings/personal-access-tokens))
2. Add new Token with the Scope `api`
1. Go to User Settings / Access tokens (for GitHub see below)
2. Add a new token with the scope `api`
![Personal Token](https://github.com/user-attachments/assets/76fb204e-450a-4516-9d93-897ae2a32f6d)
## Project Access Token
If you self-host Gitlab or have the Premium / Ultimate license it's possible to get a Project Access Token. Which are scoped to this Project.
The scope is similiar to the Personal Access token but you set also a role. Which Role can do what? <a href="https://docs.gitlab.com/ee/user/permissions.html#project-planning">Documentation</a>
If you self-host GitLab or have the Premium/Ultimate license, it's possible to get a Project Access Token, which is scoped to a project.
The scope is similar to the Personal Access token, but you also set a role. To learn what each role can do, see the <a href="https://docs.gitlab.com/ee/user/permissions.html#project-planning">Documentation</a>.
![Project Token](https://github.com/user-attachments/assets/f008f114-3d3e-450d-9301-7825222f9812)
## GitHub Personal Access Token
To generate a GitHub Personal Access Token:
1. Navigate to GitHub's [Personal Access Tokens (Classic)](https://github.com/settings/tokens) page
- Note: Fine-grained tokens are not currently supported
2. Click "Generate new token (classic)"
3. Select the `repo` scope to grant access to private repositories
4. Click "Generate token" and securely store the token value

View file

@ -201,7 +201,7 @@ function initWinEventListeners(app: any): void {
return { action: 'deny' };
});
// TODO refactor quiting mess
// TODO refactor quitting mess
appCloseHandler(app);
appMinimizeHandler(app);
}

View file

@ -12,7 +12,7 @@ export const mapGiteaIssueToSearchResult = (issue: GiteaIssue): SearchResultItem
};
};
// Gitea uses the issue number intead of issue id to track the issues
// Gitea uses the issue number instead of issue id to track the issues
export const mapGiteaIssueIdToIssueNumber = (issue: GiteaIssue): GiteaIssue => {
return { ...issue, id: issue.number };
};

View file

@ -42,7 +42,7 @@ export class UiHelperService {
focusApp(): void {
if (IS_ELECTRON) {
// otherwise the last focused task get's focused again leading to unintended keyboard events
// otherwise the last focused task gets focused again leading to unintended keyboard events
if (document.activeElement) {
(document.activeElement as HTMLElement).blur();
}

View file

@ -152,7 +152,7 @@ export class WorklogExportComponent implements OnInit, OnDestroy {
this.options = {
...WORKLOG_EXPORT_DEFAULTS,
...advancedCfg.worklogExportSettings,
// NOTE: if we don't do this typescript(?) get's aggressive
// NOTE: if we don't do this typescript(?) gets aggressive
cols: [
...(advancedCfg.worklogExportSettings
? [...advancedCfg.worklogExportSettings.cols]

View file

@ -23,7 +23,7 @@ const _generateKey = async (password: string): Promise<CryptoKey> => {
const ops = {
name: 'PBKDF2',
// TODO this is probably not very secure
// on the other hand: the salt is used for saving the password securely, so maybe it is not imporant
// on the other hand: the salt is used for saving the password securely, so maybe it is not important
// for our specific use case? We would need to need some security expert input on this
salt: enc.encode(password),
iterations: 1000,