finch-daemon

KO | EN

Minimalist Open Source Repository Search Engine

gitlite — search

#typescript #ai-agents #deepseek-harness #dsh-plugin #open-source #ai #cli #claude-code #windows #codex #developer-tools #dsh

★ 14 Open GitHub ↗

The Finch Daemon project is an open source container runtime engine that enables users to integrate software that uses Docker's RESTful APIs as a programmatic dependency.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[[⬇️ **Download]**](https://github.com/runfinch/finch-daemon/releases)
[[🚀 **All Releases]**](https://github.com/runfinch/finch-daemon/releases)
[[📚 **Installation]**](#quickstart)
[[✏️ **Contributing]**](CONTRIBUTING.md)

# Finch Daemon

The Finch Daemon project is an open source container runtime engine that enables users to integrate software that uses Docker's RESTful APIs as a programmatic dependency. Some core features include:

- A partial implementation of the [Docker API Spec v1.43](https://docs.docker.com/engine/api/v1.43/) - see [supported endpoints](docs/supported-endpoints.md) for details
 - Native support for Linux environments

The Finch Daemon project is actively taking contributions, especially to improve API compatibility.

## Onboarding & Development

Please review [CONTRIBUTING.md](./CONTRIBUTING.md) for onboarding, as well as for an overview of the development cycle for this project.
Additionally, check the [Makefile](./Makefile) for additional information on setup & configuration.

## Quickstart
Make sure [NerdCTL](https://github.com/containerd/nerdctl) and 
[Containerd](https://github.com/containerd/containerd) are installed and set up

### Linux
Getting started with Finch Daemon on Linux only requires a few steps:

1. Clone the repository - `git clone https://github.com/runfinch/finch-daemon.git`
2. `cd finch-daemon`
3. Install Go and make sure that `go version` is >= 1.22
4. Build and spin up the finch-daemon server with 
   ```bash 
   make
   sudo bin/finch-daemon --debug --socket-owner $UID
   ```
5. Test any changes with `make test-unit` and `sudo make test-e2e`

## Experimental Features

Finch Daemon includes experimental features that can be enabled using the `--experimental` flag. These features are under development and may change in future releases.

### Using Experimental Features

To enable experimental features, use the `--experimental` flag when starting the daemon:

```bash
sudo bin/finch-daemon --debug --socket-owner $UID --experimental
```

### Current Experimental Features

#### OPA Authorization Middleware

The OPA (Open Policy Agent) middleware allows you to define authorization policies for API requests using Rego policy language. This feature requires both the `--experimental` flag and the `--rego-file` flag to be set.

Example usage:
```bash
sudo bin/finch-daemon --debug --socket-owner $UID --experimental --rego-file /path/to/policy.rego
```

For detailed documentation on the OPA middleware, see [opa-middleware.md](docs/opa-middleware.md).

## Creating a systemd service
If you want finch-daemon to be managed as a systemd service, for benefits like automatic
restart if it gets killed, you can configure it as a systemd service on Linux by
following these steps:

1. `cd /path/to/finch-daemon`
2. `sudo cp finch.service /etc/systemd/system/`
3. Refresh the service files to include the new service - `sudo systemctl daemon-reload`
4. Start the service - `sudo systemctl start finch.service`
5. To check the status of the service - `sudo systemctl status finch.service`
6. To enable the service on every reboot - `sudo systemctl enable finch.service`
7. To disable the service on every reboot - `sudo systemctl disable finch.service`

## Reporting an issue

If you encounter anything that seems wrong, please check out our [issues](https://github.com/runfinch/finch-daemon/issues) tab first — someone may have already encountered your problem! If it's there, please add to the existing issue thread.

If you can't find an existing issue, feel free to open a new one. As a remninder, anything related to security should NOT go through regular reporting channels. Please refer to [Security](https://github.com/runfinch/finch-daemon?tab=security-ov-file#reporting-security-issues) for guidance on how to report such issues.

-----

Legal
=====

*Brought to you courtesy of our legal counsel. For more context,
please see the [NOTICE](https://github.com/runfinch/finch-daemon/blob/main/NOTICE) document in this repo.*

Use and transfer of Finch Daemon may be subject to certain restrictions by the
United States and other governments.

It is your responsibility to ensure that your use and/or transfer does not
violate applicable laws.

For more information, please see https://www.bis.doc.gov

Licensing
=========
Finch Daemon is licensed under the Apache License, Version 2.0. 
See [LICENSE](https://github.com/runfinch/finch-daemon/blob/main/LICENSE) for the full license text.

finch-daemon

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README