Scroll to navigation

MOVIM(1) General Commands Manual MOVIM(1)

NAME

movimMovim administration CLI utility

SYNOPSIS

movim [-h | --help] [-q | --quiet] [-V | --version] [--ansi] [--no-ansi] [-n | --no-interaction] [-v | -vv | -vvv | --verbose] subcommand [subcommand-options] [subcommand-arguments]


movim [global-options] config [--info=INFO] [--username=USERNAME] [--password=PASSWORD] [--timezone=TIMEZONE] [--loglevel=LOGLEVEL] [--locale=LOCALE] [--xmppdomain=XMPPDOMAIN] [--xmppdescription=XMPPDESCRIPTION] [--xmppcountry=XMPPCOUNTRY] [--xmppwhitelist=XMPPWHITELIST]


movim [global-options] help [--format=FORMAT] [--raw] [--] [command_name]


movim [global-options] list [--format=FORMAT] [--raw] [--] [namespace]


movim [global-options] start [--url=URL] [-p | --port[=PORT]] [-i | --interface[=INTERFACE]] [-d | --debug]

DESCRIPTION

The movim utility assists in configuring and starting the Movim server. Its behaviour is controlled by the actual subcommand invoked. Upstream documentation refers to this command as: php daemon.php

The global options are as follows:

|
Display a help message
|
Do not output any message
|
Display application's version
Force ANSI coloured output
Disable ANSI coloured output
|
Do not ask any interactive questions
| | |
Increase the verbosity, up to three times; thrice is debug logging

The help and list subcommands share these options:

FORMAT
Select the output format (txt, xml, json, md); default: txt
Output raw command help/list

SUBCOMMANDS

config

Changes the configuration. Options are as follows:

INFO
Content of the info box on the login page
USERNAME
Username for the admin area
PASSWORD
Password for the admin area
TIMEZONE
The server timezone
LOGLEVEL
The server loglevel, default 0
LOCALE
The server main locale
XMPPDOMAIN
The default XMPP server domain
XMPPDESCRIPTION
The default XMPP server description
XMPPCOUNTRY
The default XMPP server country
XMPPWHITELIST
The whitelisted XMPP servers

help

Displays help for a command. See above for global and other options. If no command_name is given, it defaults to show help for the help command itself.

list

Lists the supported subcommands. See above for global and other options. The optional namespace argument lists commands from a specific namespace, such as “test”.

start

Starts the Movim daemon. Options are as follows:

URL
Public URL of your Movim instance
| [=PORT]
Port on which the daemon will listen; default: 8080
| [=INTERFACE]
Interface on which the daemon will listen; default: 127.0.0.1
|
Output XMPP logs

CAVEATS

This command is highly dynamic. This manual page was created for Movim 0.15, but may be outdated. The documentation situation of the management commands themselves, including error handling and exit statuses, is... suboptimal.

November 20, 2019 Debian