Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Add install.sh script #197

Merged
merged 1 commit into from
Nov 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 23 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,18 +42,37 @@ Several key features:

## Quickstart

1. Create and install a GitHub App (see [Creating a GitHub App](https://docs.github.com/en/developers/apps/creating-a-github-app)) with the following permissions:

- Read access to metadata
- Read and write access to actions and organization self hosted runners

2. Note down the GitHub App ID and generate a private key, save it to a file on the host machine, e.g. `/root/private-key.pem`.
3. Download and run the installation script:

```bash
curl -sSL https://raw.githubusercontent.com/hostinger/fireactions/main/install.sh -o install.sh
chmod +x install.sh
./install.sh \
--github-app-id=<GITHUB_APP_ID> \
--github-app-key-file="/root/private-key.pem" \
--github-organization="<GITHUB_ORGANIZATION>"
--containerd-snapshotter-device="<DEVICE>"
```

Replace `<DEVICE>`, `<GITHUB_APP_ID>`, and `<GITHUB_ORGANIZATION>` with the appropriate values.

This creates a default configuration with a single pool named `default` with a single runner. See [Configuration](./docs/user-guide/configuration.md) for more information on how to customize Fireactions.

To start using self-hosted GitHub runners, add the label to your workflow jobs:

```yaml
<...>
runs-on:
- self-hosted
# e.g. fireactions-2vcpu-4gb
- <JOB_LABEL>
- fireactions
```

See [Configuration](./docs/user-guide/configuration.md) for more information on how to configure job labels.

## Contributing

See [CONTRIBUTING.md](CONTRIBUTING.md) for more information on how to contribute to Fireactions.
Expand Down
27 changes: 0 additions & 27 deletions contrib/fireactions.conflist

This file was deleted.

Loading
Loading