mirror of
https://github.com/YunoHost/moulinette.git
synced 2024-09-03 20:06:31 +02:00
Update README.md
This commit is contained in:
Alexis Gavoty
Alexis Gavoty
parent
515b33fe73
commit
cd9681459d
1 changed files with 45 additions and 94 deletions
139
README.md
139
README.md
|
|
@ -1,128 +1,79 @@
|
||||||
Under redaction
|
|
||||||
===============
|
|
||||||
|
|
||||||
|
|
||||||
YunoHost CLI
|
YunoHost CLI
|
||||||
------------
|
============
|
||||||
|
|
||||||
|
|
||||||
|
Specifications
|
||||||
|
--------------
|
||||||
|
|
||||||
### User
|
### User
|
||||||
|
|
||||||
yunohost user list [-h] [--fields FIELDS [FIELDS ...]] [-o OFFSET]
|
yunohost user list [-h] [--fields FIELDS [FIELDS ...]] [-o OFFSET]
|
||||||
[-f FILTER] [-l LIMIT]
|
[-f FILTER] [-l LIMIT]
|
||||||
yunohost user add [fields=values...]
|
yunohost user create [-h] [-u USERNAME] [-l LASTNAME] [-f FIRSTNAME]
|
||||||
yunohost user delete [users...]
|
[-p PASSWORD] [-m MAIL]
|
||||||
yunohost user update [user] --changepassword [oldpwd] [newpwd] | --mailforward [add/remove] [mails...] | -- mailalias [add/remove] [mails...] | [fields=values...]
|
yunohost user delete [-h] users [users ...]
|
||||||
yunohost user info [user]
|
yunohost user update [-h] [-remove-mailalias MAIL [MAIL ...]]
|
||||||
|
[-add-mailalias MAIL [MAIL ...]] [-f FIRSTNAME]
|
||||||
|
[-m MAIL] [-l LASTNAME]
|
||||||
|
[--remove-mailforward MAIL [MAIL ...]]
|
||||||
|
[--add-mailforward MAIL [MAIL ...]]
|
||||||
|
[-cp PASSWORD]
|
||||||
|
user
|
||||||
|
yunohost user info [-h] [-m MAIL] [-cn FULLNAME] [user]
|
||||||
|
|
||||||
|
|
||||||
### Domain
|
### Domain
|
||||||
|
|
||||||
yunohost domain list --filter=filter --limit=limit --offset=offset
|
yunohost domain list [-h] [-l LIMIT] [-o OFFSET] [-f FILTER]
|
||||||
yunohost domain add [domain]
|
yunohost domain add [-h] domain
|
||||||
yunohost domain delete [domains...]
|
yunohost domain remove [-h] domain [domain ...]
|
||||||
yunohost domain info [domain]
|
yunohost domain info [-h] domain
|
||||||
yunohost domain renewcert [domain]
|
yunohost domain renewcert [-h] domain
|
||||||
|
|
||||||
|
|
||||||
### App
|
### App
|
||||||
|
|
||||||
yunohost app list --fields=fields,.. --filter=filter --limit=limit --offset=offset
|
yunohost app list [-h] [--fields FIELDS [FIELDS ...]] [-o OFFSET]
|
||||||
yunohost app install [apps...] --domain=domain --path=path --label=label --public --protected
|
[-f FILTER] [-l LIMIT]
|
||||||
yunohost app remove [apps...]
|
yunohost app install [-h] [-d DOMAIN] [--public] [-l LABEL] [-p PATH]
|
||||||
yunohost app upgrade [apps...]
|
[--protected]
|
||||||
yunohost app info [app]
|
app [app ...]
|
||||||
yunohost app addaccess [apps...] --everyone | --users=users,..
|
yunohost app remove [-h] app [app ...]
|
||||||
yunohost app removeaccess [apps...] --everyone | --users=users,..
|
yunohost app upgrade [-h] [app [app ...]]
|
||||||
|
yunohost app info [-h] app
|
||||||
|
yunohost app addaccess [-h] [-u USER [USER ...]] app [app ...]
|
||||||
|
yunohost app removeaccess [-h] [-u USER [USER ...]] app [app ...]
|
||||||
|
|
||||||
|
|
||||||
### Repo
|
### Repo
|
||||||
|
|
||||||
yunohost repo list --filter=filter --limit=limit --offset=offset
|
yunohost repo list [-h] [-l LIMIT] [-o OFFSET] [-f FILTER]
|
||||||
yunohost repo add [url] --name=name
|
yunohost repo add [-h] [-n NAME] url
|
||||||
yunohost repo remove [name/url]
|
yunohost repo remove [-h] repo
|
||||||
yunohost repo update
|
yunohost repo update [-h]
|
||||||
|
|
||||||
|
|
||||||
### Firewall
|
### Firewall
|
||||||
|
|
||||||
yunohost firewall list
|
yunohost firewall list [-h]
|
||||||
yunohost firewall allow [port] [TCP/UDP/Both] [name]
|
yunohost firewall allow [-h] {UDP,TCP,Both} port name
|
||||||
yunohost firewall disallow [name]
|
yunohost firewall disallow [-h] name
|
||||||
|
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
|
||||||
yunohost monitor
|
yunohost monitor info #FIX
|
||||||
|
|
||||||
|
|
||||||
### Other
|
### Tools
|
||||||
|
|
||||||
yunohost paste
|
yunohost tools support #FIX
|
||||||
yunohost support
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
YunoHost REST API
|
Contribute
|
||||||
-----------------
|
----------
|
||||||
|
|
||||||
Prefix: https://mydomain.org:6767
|
Only few functions are implemented yet. If you want to contribute, just pick one action above (i.e. 'yunohost app addaccess') and make the function (here 'app_addaccess()') into the right file (here 'yunohost_app.py').
|
||||||
|
|
||||||
/route
|
|
||||||
METHOD {params}
|
|
||||||
|
|
||||||
|
|
||||||
### User
|
|
||||||
|
|
||||||
/user/list
|
|
||||||
GET {fields, filter, limit, offset}
|
|
||||||
|
|
||||||
/user
|
|
||||||
GET {user, fields}
|
|
||||||
POST {fields, fieldsvalue}
|
|
||||||
DELETE {users}
|
|
||||||
PUT {user, fields}
|
|
||||||
|
|
||||||
/user/changepassword
|
|
||||||
PUT {user, oldpwd, newpwd}
|
|
||||||
|
|
||||||
/user/mailforward
|
|
||||||
POST {mails}
|
|
||||||
DELETE {mails}
|
|
||||||
|
|
||||||
/user/mailalias
|
|
||||||
POST {mails}
|
|
||||||
DELETE {mails}
|
|
||||||
|
|
||||||
|
|
||||||
### Domain
|
|
||||||
|
|
||||||
/domain/list
|
|
||||||
GET {filter, limit, offset}
|
|
||||||
|
|
||||||
/domain
|
|
||||||
GET {domain}
|
|
||||||
POST {domain}
|
|
||||||
DELETE {domains}
|
|
||||||
|
|
||||||
/domain/renewcert
|
|
||||||
PUT {domain}
|
|
||||||
|
|
||||||
|
|
||||||
### App
|
|
||||||
|
|
||||||
/app/
|
If you need LDAP connections or openned configuration files, take a look at the connection documentation in the 'parse_args' file.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
YunoHost Web Views
|
|
||||||
------------------
|
|
||||||
|
|
||||||
### User
|
|
||||||
|
|
||||||
/user/list
|
|
||||||
/user/add
|
|
||||||
/user/show/<user>
|
|
||||||
/user/update/<user>
|
|
||||||
/user/changepassword/<user>
|
|
||||||
/user/mailforward/<user>
|
|
||||||
/user/mailalias/<user>
|
|
||||||
Loading…
Reference in a new issue