Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
drax2gma authored Feb 26, 2024
1 parent 5ec4c33 commit f1a780f
Showing 1 changed file with 7 additions and 7 deletions.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ Example:
Except for the `stats` command, all other command needs a responsible user, which must be registered beforehand. Every user registers their user, no `admin` is needed for that.

```bash
❯ https://localhost:3000/register?user=<username>&token=<new_user_token>
❯ https://example.local:3000/register?user=<username>&token=<new_user_token>
```

### Locking hosts and environments
Expand All @@ -142,9 +142,9 @@ To own a host or an environment, it must be locked.
Examples:

```bash
❯ https://localhost:3000/lock?type=host&name=<hostname>&user=<username>&token=<user_token>&lastday=<expire_day>
❯ https://example.local:3000/lock?type=host&name=<hostname>&user=<username>&token=<user_token>&lastday=<expire_day>

❯ https://localhost:3000/lock?type=env&name=<envname>&user=<username>&token=<user_token>&lastday=<expore_day>
❯ https://example.local:3000/lock?type=env&name=<envname>&user=<username>&token=<user_token>&lastday=<expore_day>
```

### Unlocking hosts and environments
Expand All @@ -156,9 +156,9 @@ Unlocking can be necessary sometimes before automatic unlocking happens, here is
Examples:

```bash
❯ https://localhost:3000/unlock?type=host&name=<hostname>&user=<username>&token=<user_token>
❯ https://example.local:3000/unlock?type=host&name=<hostname>&user=<username>&token=<user_token>

❯ https://localhost:3000/unlock?type=env&name=<envname>&user=<username>&token=<user_token>
❯ https://example.local:3000/unlock?type=env&name=<envname>&user=<username>&token=<user_token>
```

### Status queries
Expand All @@ -171,13 +171,13 @@ Later YAML format will be added too.
#### Web HTML format (human readable)

```bash
❯ https://localhost:3000/status/web
❯ https://example.local:3000/status/web
```

#### JSON format

```bash
❯ https://localhost:3000/status/json
❯ https://example.local:3000/status/json
```

## Guarantees, responsibility
Expand Down

0 comments on commit f1a780f

Please sign in to comment.