Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/tor-actions/setup-tor

Set up your GitHub Actions workflow with a specific version of Tor
https://github.com/tor-actions/setup-tor

actions github-actions setup tor

Last synced: about 1 month ago
JSON representation

Set up your GitHub Actions workflow with a specific version of Tor

Awesome Lists containing this project

README

        

# setup-tor

[![Validate](https://github.com/tor-actions/setup-tor/actions/workflows/versions.yml/badge.svg)](https://github.com/tor-actions/setup-tor/actions/workflows/versions.yml)

This action sets up a tor environment for use in actions by:

- optionally downloading and caching a version of Tor by version and adding to PATH
- registering problem matchers for error output

## Usage

See [action.yml](action.yml)

Basic:
```yaml
steps:
- uses: actions/checkout@main
- uses: tor-actions/setup-tor@main
with:
tor-version: '0.4.5.7' # The Tor version to download (if necessary) and use.
- run: tor
```

Matrix Testing:
```yaml
jobs:
build:
runs-on: ubuntu-16.04
strategy:
matrix:
tor: [ '0.4.5.7', '0.4.5-rc7' ]
name: Tor ${{ matrix.tor }} sample
steps:
- uses: actions/checkout@v2
- name: Setup tor
uses: tor-actions/setup-tor@v1
with:
tor-version: ${{ matrix.tor }}
- run: tor
```

Run as daemon and set specific port (default as `9050`):
```yaml
steps:
- uses: actions/checkout@main
- uses: tor-actions/setup-tor@main
with:
tor-version: '0.4.5.7' # The Tor version to download (if necessary) and use.
daemon: true
port: 12345
```

Run with a custom configuration file:
```yaml
steps:
- uses: actions/checkout@main
- uses: tor-actions/setup-tor@main
with:
config-path: ${{ github.workspace }}/.github/.torrc
```

Run with a custom configuration:
```yaml
steps:
- uses: actions/checkout@main
- uses: tor-actions/setup-tor@main
with:
config: |
ControlPort 9051
CookieAuthentication 0
```

## License

The scripts and documentation in this project are released under the [MIT License](LICENSE)

## Contributions

Contributions are welcome! See [Contributor's Guide](docs/contributors.md)

## Code of Conduct

:wave: Be nice. See [our code of conduct](CODE_OF_CONDUCT.md)