moulinette/action_map.yml

852 lines
26 KiB
YAML
Raw Normal View History

2012-10-22 20:52:15 +02:00
##########################################################################
# Category/actions/arguments file
#
#
# Except for general_arguments, this file contains 3 levels
# as in this sample command line:
#
# yunohost monitor info --cpu --ram
# ^ ^ ^ ^
# (script) | category | action | parameters
#
#
2012-10-22 21:09:42 +02:00
# Above example will lead to the function 'monitor_info(args)'
# in the file 'yunohost_monitor.py' with 'cpu' and 'ram'
# stored in an 'args' dictionnary.
2012-10-22 20:52:15 +02:00
#
# Usage:
# You can add a category at the first level, action at the second one,
# and arguments at the third one.
# If a connexion is needed for the action, don't forget to add it to
# the action parameters (ldap, repo, dns or firewall).
#
# Documentation:
# You can see all arguments settings at the argparse documentation:
# http://docs.python.org/dev/library/argparse.html
# #argparse.ArgumentParser.add_argument
#
2012-10-22 21:09:42 +02:00
# Don't forget to turn argument yaml style (setting: value)
2012-10-22 20:52:15 +02:00
#
##########################################################################
2012-12-01 15:33:56 +01:00
2013-02-12 13:52:11 +01:00
# TODO: Add patern for all this
2012-10-22 20:52:15 +02:00
#############################
# General args #
#############################
2012-10-22 21:09:42 +02:00
general_arguments:
-v:
full: --version
help: Display YunoHost version
action: version
version: YunoHost 2.0 beta1
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
#############################
# User #
#############################
2012-12-01 15:33:56 +01:00
user:
2012-10-22 21:09:42 +02:00
category_help: Manage users
2012-12-01 15:33:56 +01:00
actions:
2012-10-22 20:52:15 +02:00
### user_list()
2012-12-01 15:33:56 +01:00
list:
2012-10-22 21:09:42 +02:00
action_help: List users
2013-06-30 18:13:26 +02:00
api: GET /users
2012-12-01 15:33:56 +01:00
arguments:
--fields:
2012-10-22 21:09:42 +02:00
help: fields to fetch
nargs: "+"
2012-12-01 15:33:56 +01:00
-f:
2012-10-22 21:09:42 +02:00
full: --filter
help: LDAP filter used to search
2012-12-01 15:33:56 +01:00
-l:
2012-10-22 21:09:42 +02:00
full: --limit
2012-12-01 15:33:56 +01:00
help: Maximum number of user fetched
-o:
2012-10-22 21:09:42 +02:00
full: --offset
2012-12-01 15:33:56 +01:00
help: Starting number for user fetching
2012-10-22 20:52:15 +02:00
### user_create()
2012-12-01 15:33:56 +01:00
create:
2012-10-22 21:09:42 +02:00
action_help: Create user
2013-06-30 18:13:26 +02:00
api: POST /users
2012-12-01 15:33:56 +01:00
arguments:
-u:
2012-10-22 21:09:42 +02:00
full: --username
help: Must be unique
2012-11-08 19:20:13 +01:00
ask: "Username"
2012-11-09 18:04:15 +01:00
pattern: '^[a-z0-9_]+$'
2012-12-01 15:33:56 +01:00
-f:
2012-10-22 21:09:42 +02:00
full: --firstname
2012-11-08 19:20:13 +01:00
ask: "Firstname"
2012-12-01 15:33:56 +01:00
-l:
2012-10-22 21:09:42 +02:00
full: --lastname
2012-11-08 19:20:13 +01:00
ask: "Lastname"
2012-12-01 15:33:56 +01:00
-m:
2012-10-22 21:09:42 +02:00
full: --mail
help: Main mail address must be unique
2012-11-08 19:20:13 +01:00
ask: "Mail address"
pattern: '^[\w.-]+@[\w.-]+\.[a-zA-Z]{2,6}$'
2012-12-01 15:33:56 +01:00
-p:
2012-10-22 21:09:42 +02:00
full: --password
2012-11-08 19:20:13 +01:00
ask: "User password"
password: yes
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### user_delete()
2012-12-01 15:33:56 +01:00
delete:
2012-10-22 21:09:42 +02:00
action_help: Delete user
2013-07-03 21:23:11 +02:00
api: 'DELETE /users/{users}'
2012-12-01 15:33:56 +01:00
arguments:
-u:
full: --users
2012-10-22 21:09:42 +02:00
help: Username of users to delete
ask: "Users to delete"
pattern: '^[a-z0-9_]+$'
2012-10-29 17:47:37 +01:00
nargs: "*"
--purge:
action: store_true
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### user_update()
2012-12-01 15:33:56 +01:00
update:
2012-10-22 21:09:42 +02:00
action_help: Update user informations
2013-07-03 21:23:11 +02:00
api: 'PUT /users/{username}'
2012-12-01 15:33:56 +01:00
arguments:
username:
2012-10-22 21:09:42 +02:00
help: Username of user to update
2012-12-01 15:33:56 +01:00
-f:
2012-10-22 21:09:42 +02:00
full: --firstname
2012-12-01 15:33:56 +01:00
-l:
2012-10-22 21:09:42 +02:00
full: --lastname
2012-12-01 15:33:56 +01:00
-m:
2012-10-22 21:09:42 +02:00
full: --mail
2012-12-01 15:33:56 +01:00
-p:
2012-10-22 21:09:42 +02:00
full: --change-password
help: New password to set
metavar: PASSWORD
2012-12-01 15:33:56 +01:00
--add-mailforward:
2012-10-22 21:09:42 +02:00
help: Mailforward addresses to add
2013-06-08 09:50:43 +02:00
nargs: "*"
2012-10-22 21:09:42 +02:00
metavar: MAIL
2012-12-01 15:33:56 +01:00
--remove-mailforward:
2012-10-22 21:09:42 +02:00
help: Mailforward addresses to remove
2013-06-08 09:50:43 +02:00
nargs: "*"
2012-10-22 21:09:42 +02:00
metavar: MAIL
2012-12-01 15:33:56 +01:00
--add-mailalias:
2012-10-22 21:09:42 +02:00
help: Mail aliases to add
2013-06-08 09:50:43 +02:00
nargs: "*"
2012-10-22 21:09:42 +02:00
metavar: MAIL
2012-12-01 15:33:56 +01:00
--remove-mailalias:
2012-10-22 21:09:42 +02:00
help: Mail aliases to remove
2013-06-08 09:50:43 +02:00
nargs: "*"
2012-10-22 21:09:42 +02:00
metavar: MAIL
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### user_info()
2012-12-01 15:33:56 +01:00
info:
2012-10-22 21:09:42 +02:00
action_help: Get user informations
2013-07-03 21:23:11 +02:00
api: 'GET /users/{username}'
2012-12-01 15:33:56 +01:00
arguments:
2013-06-30 18:13:26 +02:00
username:
2012-12-01 15:33:56 +01:00
help: Username or mail to get informations
2012-10-22 20:52:15 +02:00
#############################
# Domain #
#############################
2012-12-01 15:33:56 +01:00
domain:
2012-10-22 21:09:42 +02:00
category_help: Manage domains
2012-12-01 15:33:56 +01:00
actions:
2012-10-22 20:52:15 +02:00
### domain_list()
2012-12-01 15:33:56 +01:00
list:
2012-10-22 21:09:42 +02:00
action_help: List domains
2013-06-30 18:13:26 +02:00
api: GET /domains
2012-12-01 15:33:56 +01:00
arguments:
-f:
2012-10-22 21:09:42 +02:00
full: --filter
help: LDAP filter used to search
2012-12-01 15:33:56 +01:00
-l:
2012-10-22 21:09:42 +02:00
full: --limit
2012-12-01 15:33:56 +01:00
help: Maximum number of domain fetched
-o:
2012-10-22 21:09:42 +02:00
full: --offset
2012-12-01 15:33:56 +01:00
help: Starting number for domain fetching
2012-10-22 20:52:15 +02:00
### domain_add()
2012-12-01 15:33:56 +01:00
add:
2012-10-22 21:09:42 +02:00
action_help: Create a custom domain
2013-06-30 18:13:26 +02:00
api: POST /domains
2012-12-01 15:33:56 +01:00
arguments:
domains:
2012-10-22 21:09:42 +02:00
help: Domain name to add
2013-02-27 22:32:31 +01:00
nargs: '+'
2012-11-09 18:04:15 +01:00
pattern: '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### domain_remove()
2012-12-01 15:33:56 +01:00
remove:
2012-10-22 21:09:42 +02:00
action_help: Delete domains
2013-07-03 21:23:11 +02:00
api: 'DELETE /domains/{domains}'
2012-12-01 15:33:56 +01:00
arguments:
domains:
2012-10-22 21:09:42 +02:00
help: Domain(s) to delete
2013-02-27 22:32:31 +01:00
nargs: "+"
2012-11-09 18:04:15 +01:00
pattern: '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### domain_info()
2012-12-01 15:33:56 +01:00
info:
2012-10-22 21:09:42 +02:00
action_help: Get domain informations
2013-07-03 21:23:11 +02:00
api: 'GET /domains/{domain}'
2012-12-01 15:33:56 +01:00
arguments:
domain:
2012-10-22 21:09:42 +02:00
help: ""
2012-11-09 18:04:15 +01:00
pattern: '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
2012-10-22 21:09:42 +02:00
2012-10-22 20:52:15 +02:00
#############################
# App #
#############################
2012-12-01 15:33:56 +01:00
app:
2012-10-22 21:09:42 +02:00
category_help: Manage apps
2012-12-01 15:33:56 +01:00
actions:
2013-02-24 17:36:58 +01:00
### app_fetchlist()
fetchlist:
2012-11-16 13:16:37 +01:00
action_help: Fetch application list from app server
2013-06-29 01:05:28 +02:00
api: PUT /app/lists
2012-11-16 13:16:37 +01:00
arguments:
-u:
full: --url
2012-12-01 15:33:56 +01:00
help: URL of remote JSON list (default http://fapp.yunohost.org/app/list/raw)
2013-02-24 17:36:58 +01:00
-n:
full: --name
help: Name of the list (default fapp)
2012-10-22 20:52:15 +02:00
2013-02-25 22:44:00 +01:00
### app_listlists()
listlists:
action_help: List fetched lists
2013-06-29 01:05:28 +02:00
api: GET /app/lists
2013-02-25 22:44:00 +01:00
2013-02-25 22:54:28 +01:00
### app_removelist()
removelist:
action_help: Remove list from the repositories
2013-06-29 01:05:28 +02:00
api: DELETE /app/lists
2013-02-25 22:54:28 +01:00
arguments:
-n:
full: --name
help: Name of the list to remove
ask: "List to remove"
pattern: '^[a-z0-9_]+$'
2012-10-22 20:52:15 +02:00
### app_list()
2012-12-01 15:33:56 +01:00
list:
2012-10-22 21:09:42 +02:00
action_help: List apps
2013-11-22 12:13:41 +01:00
api: GET /apps
2012-12-01 15:33:56 +01:00
arguments:
-l:
2012-10-22 21:09:42 +02:00
full: --limit
2012-12-01 15:33:56 +01:00
help: Maximum number of app fetched
-o:
2012-10-22 21:09:42 +02:00
full: --offset
2012-12-01 15:33:56 +01:00
help: Starting number for app fetching
-f:
full: --filter
help: Name filter of app_id or app_name
-r:
full: --raw
help: Return the full app_dict
action: store_true
2012-12-01 15:33:56 +01:00
### app_info()
info:
action_help: Get app info
api: GET /app/{app}
arguments:
app:
help: Specific app ID
-r:
full: --raw
help: Return the full app_dict
2013-10-27 15:48:10 +01:00
action: store_true
2013-03-02 11:19:20 +01:00
### app_map()
map:
action_help: List apps by domain
2013-06-29 01:05:28 +02:00
api: GET /app/map
arguments:
-a:
full: --app
help: Specific app to map
-r:
full: --raw
help: Return complete dict
action: store_true
2013-10-27 19:37:19 +01:00
-u:
full: --user
help: Allowed app map for a user
pattern: '^[a-z0-9_]+$'
2013-11-22 15:29:07 +01:00
2013-03-02 11:19:20 +01:00
2012-10-22 20:52:15 +02:00
### app_install() TODO: Write help
2012-12-01 15:33:56 +01:00
install:
2012-10-22 21:09:42 +02:00
action_help: Install apps
2013-06-29 01:05:28 +02:00
api: POST /app
2012-12-01 15:33:56 +01:00
arguments:
app:
2012-11-16 13:16:37 +01:00
help: App to install
2012-12-01 15:33:56 +01:00
-l:
2012-10-22 21:09:42 +02:00
full: --label
2013-11-22 15:29:07 +01:00
help: Custom name for the app
-a:
full: --args
help: Serialize arguments for app installation
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### app_remove() TODO: Write help
2012-12-01 15:33:56 +01:00
remove:
2012-10-22 21:09:42 +02:00
action_help: Remove app
2013-11-22 18:00:20 +01:00
api: DELETE /app/{app}
2012-12-01 15:33:56 +01:00
arguments:
app:
2012-10-22 21:09:42 +02:00
help: App(s) to delete
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### app_upgrade()
2012-12-01 15:33:56 +01:00
upgrade:
2012-10-22 21:09:42 +02:00
action_help: Upgrade app
2013-11-23 00:20:00 +01:00
api: PUT /app
2012-12-01 15:33:56 +01:00
arguments:
app:
2012-10-22 21:09:42 +02:00
help: App(s) to upgrade (default all)
nargs: "*"
-u:
full: --url
help: Git url to fetch for upgrade
-f:
full: --file
help: Folder or tarball for upgrade
2012-12-01 15:33:56 +01:00
2013-10-18 15:48:01 +02:00
### app_setting()
2013-10-25 12:11:24 +02:00
setting:
2013-10-18 15:48:01 +02:00
action_help: Set ou get an app setting value
api: GET /app/{app}/setting
arguments:
app:
help: App ID
key:
help: Key to get/set
-v:
full: --value
help: Value to set
2013-12-05 11:39:36 +01:00
-d:
full: --delete
help: Delete the key
action: store_true
2012-12-01 15:33:56 +01:00
2013-12-05 16:51:07 +01:00
### app_service()
service:
action_help: Add or remove a YunoHost monitored service
api: POST /app/service/{service}
arguments:
service:
help: Service to add/remove
-s:
full: --status
help: Custom status command
2013-12-05 16:59:19 +01:00
-l:
full: --log
help: Absolute path to log file to display
2013-12-05 16:51:07 +01:00
-r:
2013-12-05 17:10:37 +01:00
full: --runlevel
help: Runlevel priority of the service
-R:
2013-12-05 16:51:07 +01:00
full: --remove
help: Remove service
action: store_true
2013-10-27 14:23:52 +01:00
### app_checkport()
checkport:
action_help: Check availability of a local port
api: GET /app/checkport
arguments:
port:
help: Port to check
pattern: '^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$'
2013-10-26 17:29:15 +02:00
### app_checkurl()
checkurl:
action_help: Check availability of a web path
api: GET /app/checkurl
arguments:
url:
help: Url to check
-a:
full: --app
help: Write domain & path to app settings for further checks
### app_initdb()
initdb:
action_help: Create database and initialize it with optionnal attached script
api: POST /app/initdb
arguments:
user:
help: Name of the DB user
-p:
full: --password
help: Password of the DB (generated unless set)
-d:
full: --db
help: DB name (user unless set)
-s:
full: --sql
help: Initial SQL file
2013-10-28 10:39:15 +01:00
### app_ssowatconf()
ssowatconf:
action_help: Regenerate SSOwat configuration file
api: PUT /ssowatconf
2013-11-22 15:29:07 +01:00
2012-10-22 20:52:15 +02:00
### app_addaccess() TODO: Write help
2012-12-01 15:33:56 +01:00
addaccess:
2012-10-22 21:09:42 +02:00
action_help: Grant access right to users (everyone by default)
2013-06-29 01:05:28 +02:00
api: PUT /app/access
2012-12-01 15:33:56 +01:00
arguments:
2013-03-03 15:54:24 +01:00
apps:
2012-10-22 21:09:42 +02:00
nargs: "+"
2012-12-01 15:33:56 +01:00
-u:
2013-03-03 15:54:24 +01:00
full: --users
2012-10-22 21:09:42 +02:00
nargs: "+"
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### app_removeaccess() TODO: Write help
2012-12-01 15:33:56 +01:00
removeaccess:
2012-10-22 21:09:42 +02:00
action_help: Revoke access right to users (everyone by default)
2013-06-29 01:05:28 +02:00
api: DELETE /app/access
2012-12-01 15:33:56 +01:00
arguments:
2013-03-03 17:45:31 +01:00
apps:
2012-10-22 21:09:42 +02:00
nargs: "+"
2012-12-01 15:33:56 +01:00
-u:
2013-03-03 17:45:31 +01:00
full: --users
2012-10-22 21:09:42 +02:00
nargs: "+"
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
#############################
2013-06-27 20:03:07 +02:00
# Backup #
2012-10-22 20:52:15 +02:00
#############################
2013-06-27 20:03:07 +02:00
backup:
category_help: Manage backups
2012-12-01 15:33:56 +01:00
actions:
2012-10-22 20:52:15 +02:00
2013-06-27 20:03:07 +02:00
### backup_init()
init:
action_help: Init Tahoe-LAFS configuration
2013-06-29 01:05:28 +02:00
api: POST /backup/init
2012-12-01 15:33:56 +01:00
arguments:
2013-06-27 20:03:07 +02:00
--helper:
help: Init as a helper node rather than a "helped" one
action: store_true
2012-10-22 20:52:15 +02:00
#############################
# Monitor #
#############################
2012-12-01 15:33:56 +01:00
monitor:
2013-12-02 18:02:20 +01:00
category_help: Monitor the server
2012-12-01 15:33:56 +01:00
actions:
2013-12-02 18:02:20 +01:00
### monitor_disk()
disk:
action_help: Monitor disk space and usage
2012-12-01 15:33:56 +01:00
arguments:
-f:
full: --filesystem
help: Show filesystem disk space
action: append_const
const: filesystem
dest: units
-t:
full: --io
help: Show I/O throughput
action: append_const
const: io
dest: units
2012-12-01 15:33:56 +01:00
-m:
2013-12-02 18:02:20 +01:00
full: --mountpoint
help: Monitor only the device mounted on MOUNTPOINT
action: store
-H:
full: --human-readable
help: Print sizes in human readable format
2012-10-22 21:09:42 +02:00
action: store_true
2013-12-02 18:02:20 +01:00
### monitor_network()
network:
action_help: Monitor network interfaces
arguments:
2012-12-01 15:33:56 +01:00
-u:
full: --usage
help: Show interfaces bit rates
action: append_const
const: usage
dest: units
-i:
full: --infos
help: Show network informations
action: append_const
const: infos
dest: units
-H:
full: --human-readable
help: Print sizes in human readable format
2013-10-04 21:51:04 +02:00
action: store_true
2013-12-02 18:02:20 +01:00
### monitor_system()
system:
action_help: Monitor system informations and usage
arguments:
-m:
full: --memory
help: Show memory usage
action: append_const
const: memory
dest: units
2012-12-01 15:33:56 +01:00
-c:
2012-10-22 21:09:42 +02:00
full: --cpu
help: Show CPU usage and load
action: append_const
const: cpu
dest: units
-p:
full: --process
help: Show processes summary
action: append_const
const: process
dest: units
2012-12-01 15:33:56 +01:00
-u:
2012-10-22 21:09:42 +02:00
full: --uptime
help: Show the system uptime
action: append_const
const: uptime
dest: units
2012-10-28 15:55:35 +01:00
-i:
full: --infos
help: Show system informations
action: append_const
const: infos
dest: units
-H:
full: --human-readable
help: Print sizes in human readable format
2012-10-22 21:09:42 +02:00
action: store_true
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
2013-12-04 23:54:29 +01:00
#############################
# Service #
#############################
service:
category_help: Manage services
actions:
### service_start()
start:
action_help: Start one or more services
arguments:
names:
help: Service name to start
nargs: +
metavar: NAME
### service_stop()
stop:
action_help: Stop one or more services
arguments:
names:
help: Service name to stop
nargs: +
metavar: NAME
### service_enable()
enable:
action_help: Enable one or more services
arguments:
names:
help: Service name to enable
nargs: +
metavar: NAME
### service_disable()
disable:
action_help: Disable one or more services
arguments:
names:
help: Service name to disable
nargs: +
metavar: NAME
### service_status()
status:
action_help: Show status information about one or more services (all by default)
arguments:
names:
help: Service name to show
nargs: "*"
metavar: NAME
2013-12-06 12:01:43 +01:00
### service_log()
log:
2013-12-06 12:29:23 +01:00
action_help: Log every log files of a service
2013-12-06 12:01:43 +01:00
arguments:
name:
help: Service name to log
-n:
full: --number
help: Number of lines to display
pattern: '^[0-9]+$'
2013-12-09 13:27:32 +01:00
default: "50"
2013-12-06 12:01:43 +01:00
2013-12-04 23:54:29 +01:00
2012-10-22 20:52:15 +02:00
#############################
# Firewall #
#############################
2012-12-01 15:33:56 +01:00
firewall:
2012-10-22 21:09:42 +02:00
category_help: Manage firewall rules
2012-12-01 15:33:56 +01:00
actions:
2012-10-22 20:52:15 +02:00
### firewall_list()
2012-12-01 15:33:56 +01:00
list:
2012-10-22 21:09:42 +02:00
action_help: List all firewall rules
2013-06-29 01:05:28 +02:00
api: GET /firewall/list
2013-06-15 14:37:27 +02:00
2012-12-12 19:20:09 +01:00
### firewall_reload()
reload:
2013-06-29 01:05:28 +02:00
action_help: Reload all firewall rules
api: PUT /firewall/list
arguments:
-u:
full: --upnp
help: upnp
action: store_true
2012-10-22 20:52:15 +02:00
### firewall_allow()
2012-12-01 15:33:56 +01:00
allow:
2012-10-22 21:09:42 +02:00
action_help: Allow connection port/protocol
2013-06-29 01:05:28 +02:00
api: POST /firewall/port
2012-12-01 15:33:56 +01:00
arguments:
port:
2012-10-22 21:09:42 +02:00
help: Port to open
2013-10-27 14:23:52 +01:00
pattern: '^([0-9]{1,4}|[1-5][0-9]{4}|6[0-4][0-9]{3}|65[0-4][0-9]{2}|655[0-2][0-9]|6553[0-5])$'
2012-12-01 15:33:56 +01:00
protocol:
2012-10-22 21:09:42 +02:00
help: Protocol associated with port
2012-12-01 15:33:56 +01:00
choices:
- UDP
- TCP
2012-10-22 21:09:42 +02:00
- Both
2012-12-13 11:36:09 +01:00
-i:
full: --ipv6
help: ipv6
action: store_true
-u:
full: --upnp
help: upnp
action: store_true
2012-12-12 17:40:02 +01:00
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
### firewall_disallow()
2012-12-01 15:33:56 +01:00
disallow:
2012-10-22 21:09:42 +02:00
action_help: Disallow connection
2013-06-29 01:05:28 +02:00
api: DELETE /firewall/port
2012-12-01 15:33:56 +01:00
arguments:
port:
help: Port to open
protocol:
help: Protocol associated with port
choices:
- UDP
- TCP
- Both
-i:
full: --ipv6
help: ipv6
action: store_true
-u:
full: --upnp
help: upnp
action: store_true
2012-12-01 15:33:56 +01:00
2012-10-22 20:52:15 +02:00
2013-03-13 09:34:29 +01:00
### firewall_installupnp()
installupnp:
2013-03-11 23:07:16 +01:00
action_help: Add upnp cron
2013-06-29 01:05:28 +02:00
api: POST /firewall/upnp
2013-03-11 23:07:16 +01:00
2013-03-13 09:34:29 +01:00
### firewall_removeupnp()
removeupnp:
2013-03-11 23:07:16 +01:00
action_help: Remove upnp cron
2013-06-29 01:05:28 +02:00
api: DELETE /firewall/upnp
2013-03-15 14:18:30 +01:00
### firewall_stop()
stop:
action_help: Stop iptables and ip6tables
2013-06-29 01:05:28 +02:00
api: DELETE /firewall
2013-04-09 22:25:43 +02:00
2013-04-09 22:37:35 +02:00
### firewall_checkupnp()
2013-04-09 22:34:33 +02:00
checkupnp:
2013-04-09 22:25:43 +02:00
action_help: check if UPNP is install or not (0 yes 1 no)
2013-06-29 01:05:28 +02:00
api: GET /firewall/upnp
2013-06-16 14:41:29 +02:00
#############################
# DynDNS #
#############################
dyndns:
category_help: Subscribe and Update DynDNS Hosts
actions:
### dyndns_subscribe()
subscribe:
action_help: Subscribe to a DynDNS service
2013-06-29 01:05:28 +02:00
api: POST /dyndns
2013-06-16 14:41:29 +02:00
arguments:
2013-06-16 14:33:00 +02:00
--subscribe-host:
2013-06-16 14:41:29 +02:00
help: Dynette HTTP API to subscribe to
2013-06-16 14:33:00 +02:00
default: "dyndns.yunohost.org"
2013-06-16 14:41:29 +02:00
-d:
full: --domain
help: Full domain to subscribe with
-k:
full: --key
help: Public DNS key
### dyndns_update()
update:
action_help: Update IP on DynDNS platform
2013-06-29 01:05:28 +02:00
api: PUT /dyndns
2013-06-16 14:41:29 +02:00
arguments:
2013-06-16 14:33:00 +02:00
--dyn-host:
2013-06-16 14:41:29 +02:00
help: Dynette DNS server to inform
2013-06-16 14:33:00 +02:00
default: "dynhost.yunohost.org"
2013-06-16 14:41:29 +02:00
-d:
full: --domain
help: Full domain to subscribe with
-k:
full: --key
help: Public DNS key
-i:
full: --ip
help: IP address to send
### dyndns_installcron()
installcron:
action_help: Install IP update cron
2013-06-29 01:05:28 +02:00
api: POST /dyndns/cron
2013-06-16 14:41:29 +02:00
### dyndns_removecron()
removecron:
action_help: Remove IP update cron
2013-06-29 01:05:28 +02:00
api: DELETE /dyndns/cron
2013-06-16 14:41:29 +02:00
2012-10-22 20:52:15 +02:00
#############################
# Tools #
#############################
2012-12-01 15:33:56 +01:00
tools:
2012-10-22 21:09:42 +02:00
category_help: Specific tools
2012-12-01 15:33:56 +01:00
actions:
2012-10-22 20:52:15 +02:00
2012-10-26 15:26:50 +02:00
### tools_ldapinit()
2012-12-01 15:33:56 +01:00
ldapinit:
2012-10-26 15:26:50 +02:00
action_help: YunoHost LDAP initialization
2013-06-29 01:05:28 +02:00
api: POST /ldap
2012-10-26 15:26:50 +02:00
2012-10-27 17:06:43 +02:00
### tools_adminpw()
2012-12-01 15:33:56 +01:00
adminpw:
2012-10-27 17:06:43 +02:00
action_help: Change admin password
2013-06-29 01:05:28 +02:00
api: PUT /adminpw
2012-12-01 15:33:56 +01:00
arguments:
-o:
2012-10-27 17:06:43 +02:00
full: --old-password
2013-12-08 15:54:46 +01:00
ask: "Current admin password"
2012-11-09 18:04:15 +01:00
password: yes
2012-10-27 17:06:43 +02:00
-n:
full: --new-password
2012-11-09 18:04:15 +01:00
ask: "New admin password"
password: yes
2012-10-27 17:06:43 +02:00
### tools_maindomain()
maindomain:
action_help: Main domain change tool
2013-06-29 01:05:28 +02:00
api: PUT /domain/main
2012-12-01 15:33:56 +01:00
arguments:
2012-10-27 17:06:43 +02:00
-o:
full: --old-domain
2012-11-09 18:04:15 +01:00
pattern: '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
2012-10-27 17:06:43 +02:00
-n:
full: --new-domain
2012-11-09 18:04:15 +01:00
ask: "New main domain"
pattern: '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
2012-10-27 17:06:43 +02:00
2012-10-26 15:26:50 +02:00
### tools_postinstall()
2012-12-01 15:33:56 +01:00
postinstall:
2012-10-26 15:26:50 +02:00
action_help: YunoHost post-install
2013-06-29 01:05:28 +02:00
api: POST /postinstall
2012-12-01 15:33:56 +01:00
arguments:
-d:
2012-10-26 15:26:50 +02:00
full: --domain
help: YunoHost main domain
2012-11-09 18:04:15 +01:00
ask: "Main domain"
pattern: '^([a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)(\.[a-zA-Z0-9]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)*(\.[a-zA-Z]{1}([a-zA-Z0-9\-]*[a-zA-Z0-9])*)$'
2012-10-26 15:26:50 +02:00
-p:
full: --password
help: YunoHost admin password
2012-11-09 18:04:15 +01:00
ask: "New admin password"
password: yes
2013-06-16 14:41:29 +02:00
--dyndns:
help: Subscribe domain to a DynDNS service
action: store_true
2013-10-17 12:57:52 +02:00
2013-10-18 14:46:30 +02:00
#############################
# Hook #
#############################
hook:
category_help: Manage hooks
actions:
### hook_add()
add:
action_help: Store hook script to filsystem
api: PUT /hook
arguments:
action:
help: Action folder to store into
file:
help: Script to check
### hook_callback()
callback:
action_help: Execute all scripts binded to an action
api: GET /hooks
arguments:
action:
help: Action name
-a:
full: --args
help: Ordered list of arguments to pass to the script
nargs: '*'
2013-10-18 14:46:30 +02:00
### hook_check()
check:
action_help: Parse the script file and get arguments
api: GET /hook/check
arguments:
file:
2013-10-28 18:17:13 +01:00
help: File to check
2013-10-18 14:46:30 +02:00
### hook_exec()
exec:
action_help: Execute hook from a file with arguments
api: GET /hook
arguments:
file:
help: Script to execute
-a:
full: --args
help: Arguments to pass to the script