YunoHost/doc
1
0
Fork 0
mirror of https://github.com/YunoHost/doc.git synced 2024-09-03 20:06:26 +02:00
Code Issues Projects Releases Packages Wiki Activity

Update the commandline documentation

Browse source
This commit is contained in:
Alexandre Aubin 2018-08-27 21:53:18 +02:00
parent 93e9582cb6
commit 1ef222223a
2 changed files with 33 additions and 178 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

159
commandline.md
View file

@ -1,153 +1,30 @@
# Moulinette
# Administrate YunoHost in command line
**Moulinette** is the command line interface (CLI) of YunoHost administration. It allows to manage entirely YunoHost:
The command line interface (CLI) is, in the computer world, the original (and more technical) way of interacting with a computer compared to graphical interface. Command line interfaces are generally said to be more complete, powerful or efficient than a graphical interface, though it is more difficult to learn.
users, domains, applications, firewall, backup, monitoring.
In the context of YunoHost, or system administration in general, the CLI is commonly used to remotely control machines after connecting through [connecting to it via SSH](/ssh).
The other interface is a [web administration](/admin), which eliminates the need for the command line.
<div class="alert alert-info" markdown="1">
Providing a full tutorial about the command line is quite beyond the scope of the YunoHost documentation : for this, consider reading a dedicated tutorial such as [this one](https://ryanstutorials.net/linuxtutorial/) or [this one](http://linuxcommand.org/). But be reassured that you don't need to be a CLI expert to start using it !
</div>
To use Moulinette you need to connect to your server via [SSH](/ssh).
The `yunohost` command can be used to administrate your server and perform the various actions similarly to what you do on the webadmin. The command must be launched either from the `root` user or from the `admin` user by preceeding them with `sudo`. (ProTip™ : you can become `root` with the command `sudo su` as `admin`).
##yunohost
YunoHost commands usually have this kind of structure :
The command to manage YunoHost from the command line:
```bash
usage: yunohost [-h] [-v]
positional arguments:
{domain,monitor,service,firewall,backup,app,hook,dyndns,user,tools}
domain Manage domains
monitor Monitor the server
service Manage services
firewall Manage firewall rules
backup Manage backups
app Manage apps
hook Manage hooks
dyndns Subscribe and Update DynDNS Hosts
user Manage users
tools Specific tools
optional arguments:
-h, --help Show this help message and exit
-v, --version Display moulinette version
yunohost app install wordpress --label Webmail
^ ^ ^ ^
| | | |
category action argument options
```
### domain
Don't hesitate to browse and ask for more information about a given category or action using the the `--help` option. For instance, those commands :
```bash
yunohost domain [-h] {info,add,list,remove}
info Get domain information
add Create a custom domain
list List domains
remove Delete domains
yunohost --help
yunohost user --help
yunohost user create --help
```
### monitor
```bash
yunohost monitor [-h] {enable,network,show-stats,update-stats,disk,system,disable}
enable Enable server monitoring
network Monitor network interfaces
show-stats Show monitoring statistics
update-stats Update monitoring statistics
disk Monitor disk space and usage
system Monitor system information and usage
disable Disable server monitoring
```
### service
```bash
yunohost service [-h] {status,start,enable,log,stop,disable}
status Show status information about one or more services
(all by default)
start Start one or more services
enable Enable one or more services
log Log every log file of a service
stop Stop one or more services
disable Disable one or more services
```
### firewall
```bash
yunohost firewall [-h]{installupnp,checkupnp,list,stop,disallow,reload,allow,removeupnp}
installupnp Add uPnP cron
checkupnp Check if uPnP is installed or not (0 yes 1 no)
list List all firewall rules
stop Stop iptables and ip6tables
disallow Disallow connection
reload Reload all firewall rules
allow Allow connection port/protocol
removeupnp Remove uPnP cron
```
### backup
```bash
yunohost backup [-h] {init} ...
init Initialize Tahoe-LAFS configuration
```
### app
```bash
yunohost app [-h]
{map,ssowatconf,install,checkport,listlists,removelist,info,upgrade,service,fetchlist,checkurl,list,remove,removeaccess,setting,initdb,addaccess}
map List apps by domain
ssowatconf Regenerate SSOwat configuration file
install Install apps
checkport Check availability of a local port
listlists List fetched lists
removelist Remove list from the repositories
info Get app info
upgrade Upgrade app
service Add or remove a YunoHost monitored service
fetchlist Fetch application list from app server
checkurl Check availability of a web path
list List apps
remove Remove app
removeaccess Revoke access rights to users (everyone by default)
setting Set or get an app setting value
initdb Create database and initialize it with optionnal
attached script
addaccess Grant access rights to users (everyone by default)
```
### hook
```bash
yunohost hook [-h] {callback,add,check,remove,exec} ...
callback Execute all scripts bound to an action
add Store hook script to filesystem
check Parse the script file and get arguments
remove Remove hook scripts from filesystem
exec Execute hook from a file with arguments
```
### dyndns
```bash
yunohost dyndns [-h] {subscribe,update,installcron,removecron} ...
subscribe Subscribe to a DynDNS service
update Update IP on a DynDNS platform
installcron Install IP update cron
removecron Remove IP update cron
```
### user
```bash
yunohost user [-h] {info,create,list,update,delete} ...
info Get user information
create Create user
list List users
update Update user information
delete Delete user
```
### tools
```bash
yunohost tools [-h] {postinstall,maindomain,ldapinit,adminpw} ...
postinstall YunoHost post-install
maindomain Main domain change tool
ldapinit YunoHost LDAP initialization
adminpw Change admin password # Existing password required. See workaround below.
```
### admin
```bash
yunohost-reset-ldap-password Reset the admin account (Web GUI) password
```
will successively list all the categories available, then the actions available in the `user` category, then the usage of the action `user create`. You might notice that the YunoHost command tree is built with a structure similar to the YunoHost admin pages.

52
commandline_fr.md
View file

@ -1,52 +1,30 @@
# Moulinette
# Administrer YunoHost en ligne de commande
La **Moulinette** est l’interface en ligne de commande (CLI) de YunoHost. Elle permet de gérer entièrement YunoHost : utilisateurs, domaines, applications, pare-feu, sauvegardes et monitoring.
L'interface en ligne de commande (CLI) est, en informatique, la manière original (et plus technique) d'interagir avec un ordinateur comparé aux interfaces graphique. La ligne de commande est généralement considéré comme plus complète, puissante et efficace que les interface graphique, bien que plus difficile à apprendre.
L’autre interface est l’[administration web](/admin_fr), qui permet de se passer de la ligne de commande.
Dans le contexte de YunoHost, ou de l'administration système en général, la ligne de commande est communément utilisée après s'être [connecté en SSH](/ssh).
Pour utiliser la Moulinette il faut se connecter à son serveur en [SSH](/ssh_fr).
<div class="alert alert-info" markdown="1">
Fournir un tutorial complet sur la ligne de commande est bien au dela du cadre de la documentation de YunoHost : pour cela, référez-vous à des tutoriaux comme [celui-ci](https://doc.ubuntu-fr.org/tutoriel/console_ligne_de_commande) ou [celui-ci (en)](http://linuxcommand.org/). Mais soyez rassurer qu'il n'y a pas besoin d'être un expert pour commencer à l'utiliser !
</div>
### Utilisation
La commande `yunohost` peut être utilisée pour administrer votre serveur ou réaliser les mêmes actions que celles disponibles sur la webadmin. Elle doit être lancée en depuis l'utilisateur `root`, ou bien depuis l'utilisateur `admin` en précédant la commande de `sudo`. (ProTip™ : il est possible de devenir `root` via la commande `sudo su` en tant qu'`admin`.)
Les commandes YunoHost ont ce type de structure :
La moulinette fonctionne avec deux niveaux de sous-commandes, par exemple :
```bash
yunohost user create
yunohost app install wordpress --label Webmail
^ ^ ^ ^
| | | |
categorie action argument options
```
Vous pouvez y adjoindre des arguments pour certaines commandes :
```bash
yunohost app install roundcube --label Webmail
```
N'hesitez pas à naviguer et demander des informations à propos d'une catégorie ou action donnée via l'option `--help`. Par exemple, ces commandes :
Pour obtenir de l’aide à tout moment sur l’utilisation d’une commande ou d’une sous-commande, vous pouvez ajouter ```-h``` ou ```--help``` à la commande. Essayez par exemple :
```bash
yunohost --help
yunohost user --help
yunohost user create --help
```
---
Ça y est, vous savez utiliser la moulinette ! N’hésitez pas à parcourir ses fonctions.
```bash
root@yunohost:~# yunohost --help
usage: yunohost [-h] [-v]
{domain,monitor,firewall,backup,app,hook,dyndns,user,tools}
...
positional arguments:
{domain,monitor,firewall,backup,app,hook,dyndns,user,tools}
domain Manage domains
monitor Monitoring functions
firewall Manage firewall rules
backup Manage backups
app Manage apps
hook Manage hooks
dyndns Subscribe and Update DynDNS Hosts
user Manage users
tools Specific tools
optional arguments:
-h, --help show this help message and exit
-v, --version Display YunoHost version
```
vont successivement lister toutes les catégories disponibles, puis les actions de la catégorie `user`, puis expliquer comment utiliser l'action `user create`. Vous devriez remarquer que l'arbre des commandes YunoHost suit une structure similaire aux pages de la webadmin.