AICE GitHub Dashboard Server

Usage

Run app with the prepared configuration file and following command:

cargo run -- -c <CONFIG_PATH> \
--cert <CERT_PATH> \
--key <KEY_PATH>

Arguments

Name	Description	Required
<CONFIG_PATH>	Path to the TOML configuration file.	Yes
<CERT_PATH>	Path to the certificate file.	Yes
<KEY_PATH>	Path to the private key file.	Yes

Accessing the Web Interface

• Open https://localhost:8000 in your browser to run the app.
• Visit https://localhost:8000/graphql/playground to access the GraphQL playground.

Flags

• -h, --help: Displays help information.
• -V, --version: Displays version information.

Requirements for GitHub Personal Access Token

In order to use this repository, you need GitHub personal access token.

• Type of token should be fine-grained personal access token.
• Minimum required permissions of token are as follows:
  • Repository Access: Access to all repositories
  • Organization Permissions: Read-only access to organization projects
  • Repository Permissions: Read-only access to issues and pull requests (access to metadata will be automatically added)

Configuration

In the configuration file, you can specify the following options:

[web]

Field	Description	Required	Default
address	IP address and port the web server listens on	No	127.0.0.1:8000

[[repositories]]

Field	Description	Required	Default
owner	The owner of the GitHub repository	Yes	-
name	The name of the GitHub repository	Yes	-

[certification]

Field	Description	Required	Default
token	A GitHub fine-grained personal access token	Yes	-
ssh	The path to SSH private key for GitHub code checkout	Yes	-

• token: A GitHub fine-grained personal access token. See requirements for GitHub personal access token.
• ssh: To provide an SSH passphrase, set the SSH_PASSPHRASE environment variable.

[database]

Field	Description	Required	Default
db_path	Folder where the fjall database files are stored	No	github-dashboard

Configuration Example

[web]
address = "127.0.0.1:8000"

[[repositories]]
owner = "aicers"
name = "github-dashboard-server"

[[repositories]]
owner = "aicers"
name = "github-dashboard-client"

[certification]
token = "github_token_info"
ssh = ".ssh/id_ed25519"

[database]
db_path = "github-dashboard"

GitHub GraphQL API Testing

The GitHub GraphQL API used in this project was last tested on 2025-05-19. It is advisable to regularly review breaking changes in the GitHub GraphQL API.