Skip to content

Commit e4f497d

Browse files
committed
chore: runner
1 parent d969d86 commit e4f497d

File tree

2 files changed

+23
-12
lines changed

2 files changed

+23
-12
lines changed

src/administration-guide/api.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,18 @@
11
# API
22

3-
### API documentation
3+
## API reference
44

55
<div class="warning">
66
Full API documentation is available in <a href="https://semaphoreui.com/api-docs">API reference</a>.
77
</div>
88

9-
### How to use the Semaphore API
9+
## Creating API token
10+
11+
### Create API token
12+
13+
<img style="aspect-ratio: 1920/1440" src="https://www.semaphoreui.com/uploads/v2.14/tokens.webp">
14+
15+
### CLI
1016

1117
Login to Semaphore (password should be escaped, `slashy\\pass` instead of `slashy\pass` e.g.):
1218

src/administration-guide/runners.md

Lines changed: 15 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,8 @@ Using runners offers the following advantages:
1717

1818
## Set up
1919

20+
### Set up a server
21+
2022
To set up the server for working with running you should add following option to your Semaphore server configuration:
2123

2224
```json
@@ -26,6 +28,15 @@ To set up the server for working with running you should add following option to
2628
}
2729
```
2830

31+
or with using environment variables:
32+
33+
```bash
34+
SEMAPHORE_USE_REMOTE_RUNNER=True
35+
SEMAPHORE_RUNNER_REGISTRATION_TOKEN=long_string_of_random_characters
36+
```
37+
38+
### Setup a runner
39+
2940
To set up the runner, use the following command:
3041

3142
```bash
@@ -36,13 +47,13 @@ This command will create a configuration file at `/path/to/your/config/file.json
3647

3748
But before using this command, you need to understand how runners are registered on the server.
3849

39-
### Registering the Runner on the Server
50+
### Registering the runner on the server
4051

4152
There are two ways to register a runner on the Semaphore server:
4253
1) Add it via the web interface or API.
4354
2) Use the command line with the `semaphore runner register` command.
4455

45-
#### Adding the Runner via the Web Interface
56+
#### Adding the runner via the web UI
4657

4758
<img src="https://github.com/user-attachments/assets/8b0f7890-5767-4139-932d-3e39c217fd57" width="600">
4859

@@ -58,7 +69,7 @@ or
5869

5970
`echo REGISTRATION_TOKEN | semaphore runner register --stdin-registration-token --config /path/to/your/config/file.json`
6071

61-
### Configuration File
72+
### Configuration file
6273

6374
As a result of running the `semaphore runner setup` command, a configuration file like the following will be created:
6475

@@ -88,20 +99,14 @@ You can manually edit this file without needing to call `semaphore runner setup`
8899

89100
To re-register the runner, you can use the `semaphore runner register` command. This will overwrite the token in the file specified in the configuration.
90101

91-
## Running the Runner
102+
## Running the runner
92103

93104
Now you can start the runner with the command:
94105

95106
```
96107
semaphore runner start --config /path/to/your/config/file.json
97108
```
98109

99-
<!-- If everything is set up correctly, you will see the following output in the console:
100-
101-
```
102-
103-
``` -->
104-
105110
Your runner is ready to execute tasks ;)
106111

107112
## Runner unregistaration

0 commit comments

Comments
 (0)