File: index.md

package info (click to toggle)
golang-github-nicholas-fedor-shoutrrr 0.8.17-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 4,332 kB
  • sloc: sh: 61; makefile: 5
file content (61 lines) | stat: -rw-r--r-- 1,572 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
# Verify

## Overview

The `verify` command checks the validity of a notification service URL.

## Usage

```bash title="Verify Command Syntax"
shoutrrr verify [FLAGS]
```

| Flag                | Description                                           |
|---------------------|-------------------------------------------------------|
| `-h, --help`        | Displays help for the `verify` command.                |
| `-u, --url string`  | Specifies the notification service URL to verify.      |

!!! Note
    The `--url` flag is required. The command validates the URL format and service configuration, reporting errors for issues like unknown services or invalid URL formats.

### URL

- Specifies the service URL to validate. The URL is parsed to identify the service, and its configuration is checked for correctness.

## Examples

<!-- markdownlint-disable -->
### Verify a Valid Discord URL

!!! Example
    ```bash title="Verify Discord URL"
    shoutrrr verify --url "discord://abc123@123456789"
    ```

    ```text title="Expected Output"
    Token: abc123
    WebhookID: 123456789
    ```

### Verify an Invalid URL

!!! Example
    ```bash title="Verify Invalid URL"
    shoutrrr verify --url "invalid://abc123"
    ```

    ```text title="Expected Output"
    error verifying URL: service not recognized
    ```

### Verify a Malformed URL

!!! Example
    ```bash title="Verify Malformed URL"
    shoutrrr verify --url "discord://"
    ```

    ```text title="Expected Output"
    error verifying URL: invalid URL format
    ```
<!-- markdownlint-restore -->