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

Docs improvements #4863

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open
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
9 changes: 9 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,15 @@ This website is built using [Docusaurus 3](https://docusaurus.io/), a modern sta
pnpm install
```

## Before your first build

Before running `build` or `start` commands for the first time, you need to build plugins in docs/plugins/woodpecker-plugins:

```bash
cd docs/plugins/woodpecker-plugins
pnpm build
```

## Local Development

```bash
Expand Down
23 changes: 22 additions & 1 deletion docs/docs/30-administration/22-backends/20-local.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,14 +27,35 @@ code and execute commands.
In order to use this backend, you need to download (or build) the
[agent](https://github.com/woodpecker-ci/woodpecker/releases/latest), configure it and run it on the host machine.

## Installation

Installation is possible as a build from source or pre-build packages available on the [woodpecker GitHub release page](https://github.com/woodpecker-ci/woodpecker/releases/latest).

Once installed (e.g. via `dpkg -i ...`) it will add a systemd service called `woodpecker-agent`.

You may need to tune up that service config by for example adjusting the user it runs as.

Additionally, you must set up the [environment variables](../15-agent-config.md) for the agent in the environment referenced by the systemd service (e.g. `/etc/woodpecker/woodpecker-agent.env`).

## Usage

To enable the local backend, set the following:
To enable the local backend, set the following as an agent environment variable:

```ini
WOODPECKER_BACKEND=local
```

For more configuration options, see the [Agent configuration](../15-agent-config.md) page.

Once the agent is running, you can ensure your pipeline only is being used by that kind of agent by using proper [labels](../../20-usage/20-workflow-syntax.md#labels) configuration.

e.g:

```yaml
labels:
backend: local
```

### Shell

The `image` entrypoint is used to specify the shell, such as `bash` or `fish`, that is
Expand Down