docs: adjust documentation to reflect single-binary deployments
This commit is contained in:
@ -41,9 +41,9 @@ Creates a zip file with all vikunja-related files.
|
||||
This includes config, version, all files and the full database.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja dump
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
### `help`
|
||||
|
||||
@ -51,37 +51,37 @@ Shows more detailed help about any command.
|
||||
|
||||
Usage:
|
||||
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja help [command]
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
### `migrate`
|
||||
|
||||
Run all database migrations which didn't already run.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja migrate [flags]
|
||||
$ vikunja migrate [command]
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
#### `migrate list`
|
||||
|
||||
Shows a list with all database migrations.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja migrate list
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
#### `migrate rollback`
|
||||
|
||||
Roll migrations back until a certain point.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja migrate rollback [flags]
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
Flags:
|
||||
* `-n`, `--name` string: The id of the migration you want to roll back until.
|
||||
@ -91,18 +91,18 @@ Flags:
|
||||
Restores a previously created dump from a zip file, see `dump`.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja restore <path to dump zip file>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
### `testmail`
|
||||
|
||||
Sends a test mail using the configured smtp connection.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja testmail <email to send the test mail to>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
### `user`
|
||||
|
||||
@ -113,9 +113,9 @@ Bundles a few commands to manage users.
|
||||
Enable or disable a user. Will toggle the current status if no flag (`--enable` or `--disable`) is provided.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja user change-status <user id> <flags>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
Flags:
|
||||
* `-d`, `--disable`: Disable the user.
|
||||
@ -126,9 +126,9 @@ Flags:
|
||||
Create a new user.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja user create <flags>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
Flags:
|
||||
* `-a`, `--avatar-provider`: The avatar provider of the new user. Optional.
|
||||
@ -144,9 +144,9 @@ With the flag the user is deleted **immediately**.
|
||||
|
||||
**USE WITH CAUTION.**
|
||||
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja user delete <id> <flags>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
Flags:
|
||||
* `-n`, `--now` If provided, deletes the user immediately instead of emailing them first.
|
||||
@ -156,18 +156,18 @@ Flags:
|
||||
Shows a list of all users.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja user list
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
#### `user reset-password`
|
||||
|
||||
Reset a users password, either through mailing them a reset link or directly.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja user reset-password <flags>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
Flags:
|
||||
* `-d`, `--direct`: If provided, reset the password directly instead of sending the user a reset mail.
|
||||
@ -178,9 +178,9 @@ Flags:
|
||||
Update an existing user.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja user update <user id>
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
Flags:
|
||||
* `-a`, `--avatar-provider`: The new avatar provider of the new user.
|
||||
@ -193,15 +193,15 @@ Prints the version of Vikunja.
|
||||
This is either the semantic version (something like `0.7`) or version + git commit hash.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja version
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
||||
### `web`
|
||||
|
||||
Starts Vikunja's REST api server.
|
||||
|
||||
Usage:
|
||||
{{< highlight bash >}}
|
||||
```
|
||||
$ vikunja web
|
||||
{{< /highlight >}}
|
||||
```
|
||||
|
Reference in New Issue
Block a user