mirror of
https://github.com/YunoHost/doc.git
synced 2024-09-03 20:06:26 +02:00
bugfixes to english versions
This commit is contained in:
jacook
parent
b6ffd2e9a4
commit
7e11e96da8
7 changed files with 61 additions and 61 deletions
6
admin.md
6
admin.md
|
|
@ -1,11 +1,11 @@
|
|||
# Administrator web interface
|
||||
|
||||
Yunohost have an administrator web interface. The other way to administer your yunohost install is through the [cli called "moulinette"](#/moulinette_fr)
|
||||
Yunohost has an administrator web interface. The other way to administer your Yunohost install is through the [CLI called "moulinette"](#/moulinette_fr)
|
||||
|
||||
**please note** that the web interface is in active work in progress and has until now far less features than the cli "moulinette".
|
||||
**Please note** that the web interface is an active work-in-progress and has far fewer features than the CLI moulinette.
|
||||
|
||||
### Access
|
||||
|
||||
You can access to your administrator web interface at this address : https://your-domain.org/ynhadmin (replace your-domain.org by your own domaine name)
|
||||
You can access your administrator web interface at this address: https://your-domain.org/ynhadmin (replace 'your-domain.org' with your own domain name)
|
||||
|
||||
<div class="text-center"><img src="http://pix.toile-libre.org/upload/original/1385468349.png"></div>
|
||||
|
|
|
|||
2
help.md
2
help.md
|
|
@ -1,6 +1,6 @@
|
|||
#About this site
|
||||
|
||||
Except specific mention, the content of this website is under Creative Common ```CC-By-SA``` license.
|
||||
Unless specifically mentioned, the content of this website is licensed under the Creative Commons ```CC-By-SA``` license.
|
||||
|
||||
http://creativecommons.org/licenses/by-sa/3.0/
|
||||
|
||||
|
|
|
|||
12
index.md
12
index.md
|
|
@ -19,13 +19,13 @@ border-radius: 5px; border: 1px solid rgba(0,0,0,0.15); box-shadow: 0 5px 15px r
|
|||
|
||||
### <blockquote>Features</blockquote>
|
||||
|
||||
By default, YunoHost provides a secure solution to manage your mail & instant messaging addresses with ease, using nice interfaces.
|
||||
By default, YunoHost provides a secure solution to manage your mail & instant messaging addresses with ease, while using nice interfaces.
|
||||
|
||||
You will also be able to extend your server's capabilities by installing [**apps**](#/apps) in one click.
|
||||
You will also be able to extend your server's capabilities by installing [**apps**](#/apps) with one click.
|
||||
|
||||
### <blockquote>Softwares</blockquote>
|
||||
### <blockquote>Software</blockquote>
|
||||
|
||||
Based on [Debian GNU/Linux](http://www.debian.org/index.en.html) (wheezy), YunoHost is brought with the following free softwares:
|
||||
Based on [Debian GNU/Linux](http://www.debian.org/index.en.html) (wheezy), YunoHost comes with the following free software:
|
||||
* [Nginx](http://nginx.org/)
|
||||
* [Postfix](http://www.postfix.org/)
|
||||
* [Metronome](http://www.lightwitch.org/metronome)
|
||||
|
|
@ -38,13 +38,13 @@ Based on [Debian GNU/Linux](http://www.debian.org/index.en.html) (wheezy), YunoH
|
|||
* [Tahoe-LAFS](https://tahoe-lafs.org/trac/tahoe-lafs)
|
||||
* [SSOwat](https://github.com/Kloadut/SSOwat)
|
||||
|
||||
YunoHost automatically configures all these softwares at installation, unifying their usage through a [web interface](#/admin) or via the command-line interface called "[moulinette](#/moulinette)".
|
||||
YunoHost automatically configures all these of applications at installation, unifying their usage through a [web interface](#/admin) or via the command-line interface called "[moulinette](#/moulinette)".
|
||||
|
||||
### <blockquote>Security</blockquote>
|
||||
|
||||
Every protocol used in YunoHost is secured by default. You will get a self-signed certificate automatically for every served domain.
|
||||
|
||||
Moreover, all the softwares used in YunoHost are known free and open-source projects, meaning that they are less likely vulnerables to security flaws.
|
||||
Moreover, all of the software used in YunoHost is composed of known free and open-source projects, meaning that they are less likely to be vulnerable to security flaws.
|
||||
|
||||
A firewall is also deployed at installation, protecting you from undesirable and dangerous connections.
|
||||
|
||||
|
|
|
|||
12
install.md
12
install.md
|
|
@ -2,19 +2,19 @@
|
|||
|
||||
You have two ways to install YunoHost:
|
||||
|
||||
1. From an USB key or a CD-ROM (below guide)
|
||||
2. [Through the install script on an existing Debian](/#/install_on_debian)
|
||||
1. From a USB key or a CD-ROM (below guide)
|
||||
2. [Through the install script on an existing Debian system](/#/install_on_debian)
|
||||
|
||||
### Pre-requisite
|
||||
|
||||
* An x86 [compatible machine](/#/compatible_hardware) dedicated to YunoHost. Be careful not to have any unsaved data on it.
|
||||
* Another computer to read this guide and access your server.
|
||||
* A [reasonable ISP](/#/isp), with a good upload bandwidth, unlimited download/upload, and tolerant of self-hosting.
|
||||
* An x86-[compatible machine](/#/compatible_hardware) dedicated for YunoHost. Be careful not to have any unsaved data on it before installation.
|
||||
* Another computer to read this guide and to access your server.
|
||||
* A [reasonable ISP](/#/isp), with good upstream bandwidth, unlimited download/upload, and tolerant of self-hosting.
|
||||
* A USB key (via [Unetbootin](http://unetbootin.net/more-infos-and-get-it/)) or a CD burned with the latest YunoHost ISO: http://build.yunohost.org
|
||||
|
||||
### Boot on CD-ROM drive or USB key
|
||||
|
||||
Boot up your server with you USB key or your CD-ROM inserted, and select it as bootable device by pressing one of the following key (hardware specific): ```<ESC>```, ```<F8>```, ```<F10>```, ```<F11>```, ```<F12>``` ou ```<SUPPR>```
|
||||
Boot up your server with the USB key or a CD-ROM inserted, and select it as bootable device by pressing one of the following keys (hardware specific): ```<ESC>```, ```<F8>```, ```<F10>```, ```<F11>```, ```<F12>``` ou ```<SUPPR>```
|
||||
|
||||
|
||||
### Installation process
|
||||
|
|
|
|||
|
|
@ -2,14 +2,14 @@
|
|||
|
||||
You have two ways to install Yunohost:
|
||||
|
||||
1. [From an USB key or a CD-ROM](#/install)
|
||||
2. With the install script on an existing Debian (guide below)
|
||||
1. [From a USB key or a CD-ROM](#/install)
|
||||
2. With the install script on an existing Debian system (guide below)
|
||||
|
||||
### Pre-requisite
|
||||
A box, a VPS, or a dedicated server:
|
||||
|
||||
* with Debian 7 (Wheezy, Raspbian, Cubian, etc.) installed
|
||||
* connected to Internet
|
||||
* connected to the Internet
|
||||
* with root access or sudoer via SSH
|
||||
|
||||
### Installation
|
||||
|
|
@ -24,7 +24,7 @@ ssh root@monserveur.org
|
|||
apt-get install git
|
||||
```
|
||||
|
||||
3. Clone the Yonuhost install script repository
|
||||
3. Clone the Yunohost install script repository
|
||||
```bash
|
||||
git clone https://github.com/YunoHost/install_script /tmp/install_script
|
||||
```
|
||||
|
|
@ -36,10 +36,10 @@ cd /tmp/install_script && ./install_yunohostv2
|
|||
|
||||
### Post-install
|
||||
|
||||
Once the installation is finished, the script will ask you two parameters to proceed the post-installation:
|
||||
Once the installation is finished, the script will ask you for two options to complete the installation:
|
||||
|
||||
1. **domain name**: Please choose the domain name wich will point to your Yunohost IP. You can choose to use a subdomain of **nohost.me** or **noho.st**, in that case the DNS configuration will be automatic, you will just have to wait three minutes to the end of the post-install. Or you can use your own [well configured domain name](#/dns)
|
||||
1. **domain name**: Please choose the domain name which will point to your Yunohost IP. You can choose to use a subdomain of **nohost.me** or **noho.st**, in that case the DNS configuration will be automatic, you will just have to wait three minutes to the end of the post-install. Or you can use your own [properly configured domain name](#/dns)
|
||||
|
||||
2. **administrator password**: this is the password to administer your yunohost instance, **choose it strong** and don't share it, without it you can loose your system.
|
||||
2. **administrator password**: this is the password to administer your Yunohost instance, **make it strong** and don't share it, without it you can lose access to your system.
|
||||
|
||||
After the post-installation, you will be able to access your administration [web interface](#/admin) **https://your-domain.org/ynhadmin** or to administer your Yunohost via the command-line interface called "[moulinette](#/moulinette)".
|
||||
After the installation is complete, you will be able to access your administration [web interface](#/admin) **https://your-domain.org/ynhadmin**, or to administer your Yunohost via the command-line interface called "[moulinette](#/moulinette)".
|
||||
|
|
|
|||
|
|
@ -4,7 +4,7 @@
|
|||
|
||||
##yunohost
|
||||
|
||||
la command de base est yunohost
|
||||
The command to manage YunoHost from the command line:
|
||||
```bash
|
||||
usage: yunohost [-h] [-v]
|
||||
|
||||
|
|
@ -22,14 +22,14 @@ positional arguments:
|
|||
tools Specific tools
|
||||
|
||||
optional arguments:
|
||||
-h, --help show this help message and exit
|
||||
-h, --help Show this help message and exit
|
||||
-v, --version Display moulinette version
|
||||
```
|
||||
|
||||
### domain
|
||||
```bash
|
||||
yunohost domain [-h] {info,add,list,remove}
|
||||
info Get domain informations
|
||||
info Get domain information
|
||||
add Create a custom domain
|
||||
list List domains
|
||||
remove Delete domains
|
||||
|
|
@ -43,7 +43,7 @@ yunohost monitor [-h] {enable,network,show-stats,update-stats,disk,system,disabl
|
|||
show-stats Show monitoring statistics
|
||||
update-stats Update monitoring statistics
|
||||
disk Monitor disk space and usage
|
||||
system Monitor system informations and usage
|
||||
system Monitor system information and usage
|
||||
disable Disable server monitoring
|
||||
```
|
||||
|
||||
|
|
@ -54,7 +54,7 @@ yunohost service [-h] {status,start,enable,log,stop,disable}
|
|||
(all by default)
|
||||
start Start one or more services
|
||||
enable Enable one or more services
|
||||
log Log every log files of a service
|
||||
log Log every log file of a service
|
||||
stop Stop one or more services
|
||||
disable Disable one or more services
|
||||
```
|
||||
|
|
@ -62,20 +62,20 @@ yunohost service [-h] {status,start,enable,log,stop,disable}
|
|||
### firewall
|
||||
```bash
|
||||
yunohost firewall [-h]{installupnp,checkupnp,list,stop,disallow,reload,allow,removeupnp}
|
||||
installupnp Add upnp cron
|
||||
checkupnp check if UPNP is install or not (0 yes 1 no)
|
||||
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
|
||||
removeupnp Remove uPnP cron
|
||||
```
|
||||
|
||||
### backup
|
||||
```bash
|
||||
yunohost backup [-h] {init} ...
|
||||
init Init Tahoe-LAFS configuration
|
||||
init Initialize Tahoe-LAFS configuration
|
||||
```
|
||||
|
||||
### app
|
||||
|
|
@ -95,17 +95,17 @@ yunohost app [-h]
|
|||
checkurl Check availability of a web path
|
||||
list List apps
|
||||
remove Remove app
|
||||
removeaccess Revoke access right to users (everyone by default)
|
||||
setting Set ou get an app setting value
|
||||
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 right to users (everyone by default)
|
||||
addaccess Grant access rights to users (everyone by default)
|
||||
```
|
||||
|
||||
### hook
|
||||
```bash
|
||||
yunohost hook [-h] {callback,add,check,remove,exec} ...
|
||||
callback Execute all scripts binded to an action
|
||||
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
|
||||
|
|
@ -116,7 +116,7 @@ yunohost hook [-h] {callback,add,check,remove,exec} ...
|
|||
```bash
|
||||
yunohost dyndns [-h] {subscribe,update,installcron,removecron} ...
|
||||
subscribe Subscribe to a DynDNS service
|
||||
update Update IP on DynDNS platform
|
||||
update Update IP on a DynDNS platform
|
||||
installcron Install IP update cron
|
||||
removecron Remove IP update cron
|
||||
```
|
||||
|
|
@ -124,10 +124,10 @@ yunohost dyndns [-h] {subscribe,update,installcron,removecron} ...
|
|||
### user
|
||||
```bash
|
||||
yunohost user [-h] {info,create,list,update,delete} ...
|
||||
info Get user informations
|
||||
info Get user information
|
||||
create Create user
|
||||
list List users
|
||||
update Update user informations
|
||||
update Update user information
|
||||
delete Delete user
|
||||
```
|
||||
|
||||
|
|
|
|||
|
|
@ -1,13 +1,13 @@
|
|||
# App packaging
|
||||
|
||||
There are few things to know if you want to package an application for YunoHost.
|
||||
There are few things you need to know if you want to package an application for YunoHost.
|
||||
|
||||
### Content
|
||||
A YunoHost package looks like [this](https://github.com/Kloadut/roundcube_ynh), and is composed of:
|
||||
|
||||
* A JSON file `manifest.json`
|
||||
* A `scripts` directory, which contains the `install`, `remove` and `upgrade` scripts
|
||||
* Optionnal other directories, like `sources` or `conf` if you need them
|
||||
* Optional other directories, like `sources` or `conf` if you need them
|
||||
|
||||
|
||||
### Manifest
|
||||
|
|
@ -48,18 +48,18 @@ The `manifest.json` file defines the app's constants, a bunch of values that Yun
|
|||
}
|
||||
```
|
||||
|
||||
* **name** : The name of the app. It does not have to be unique, but it should since it is the shown name to all the YunoHost administrators in the app list.
|
||||
* **name** : The name of the app. It does not have to be unique, but it should be, since it is the name shown to all the YunoHost administrators in the app list.
|
||||
|
||||
* **id** : The unique ID of the app. You have to ensure that this ID is unique before submit an app integration request.
|
||||
|
||||
* **description** : The complete description of the app. You can make it as detailed as you feel it legit. Only `en` is required right now, but you can translate the description by prepending the locale prefix.
|
||||
* **description** : The complete description of the app. You can make it as detailed as you feel it should be. Only `en` is required right now, but you can translate the description by prepending the locale prefix.
|
||||
|
||||
* **developer** : Some informations about the app maintainer.
|
||||
* **developer** : Some information about the app maintainer (you!).
|
||||
|
||||
* **multi_instance** : This defines your app's ability to be installed multiple times. When YunoHost tries to install a second instance of your app, it will replace the `id` in your scripts by an `id__2`. It means that if you want to be `multi_instance`, you have to put all the identifiers in the scripts.
|
||||
<br><br>**E.g.** In my roundcube script, I have to call my database `roundcube`, my install directory `roundcube` and my Nginx configuration `roundcube`. This way, the second instance of roundcube will not conflict, and will be installed in the `roundcube__2` database, in the `roundcube__2`directory, and with the `roundcube__2` Nginx configuration.
|
||||
* **multi_instance** : This defines your app's ability to be installed multiple times. When YunoHost tries to install a second instance of your app, it will replace the `id` in your scripts by an `id__2`. It means that, if you want to be `multi_instance`, you have to put all the identifiers in the scripts.
|
||||
<br><br>**E.g.** In my roundcube script, I have to call my database `roundcube`, my install directory `roundcube` and my nginx configuration `roundcube`. This way, the second instance of roundcube will not conflict, and will be installed in the `roundcube__2` database, in the `roundcube__2`directory, and with the `roundcube__2` nginx configuration.
|
||||
|
||||
* **arguments** : The settings to ask to the YunoHost's administrator at installation. You have to set a `name` (for argument identification), and a question in `ask` (at least in `en`) that you can translate like the description above. You can also set a `default` value and an `example` to help administrator to fill the input.
|
||||
* **arguments** : The settings for the YunoHost's administrator to enter at installation. You have to set a `name` (for argument identification), and a question in `ask` (at least in `en`) that you can translate like the description above. You can also set a `default` value and an `example` to help administrator to fill the input.
|
||||
|
||||
## Scripts
|
||||
|
||||
|
|
@ -111,28 +111,28 @@ sed -i "s@PATHTOCHANGE@$path@g" ../conf/nginx.conf
|
|||
sed -i "s@ALIASTOCHANGE@$final_path/@g" ../conf/nginx.conf
|
||||
sudo cp ../conf/nginx.conf /etc/nginx/conf.d/$domain.d/roundcube.conf
|
||||
|
||||
# Reload Nginx and regenerate SSOwat conf
|
||||
# Reload nginx and regenerate SSOwat conf
|
||||
sudo service nginx reload
|
||||
sudo yunohost app ssowatconf
|
||||
```
|
||||
|
||||
### Usage
|
||||
You have to put everything in the script in order to install your app flawlessly. It means that you have to install dependencies, create required repositories, initialize potential databases, copy sources and configure everything in the single `install` script (and of course do the reverse process in the `remove` script).
|
||||
You have to put everything in the script in order for the app to install without issue. It means that you have to install dependencies, create required repositories, initialize potential databases, copy sources and configure everything in the single `install` script (and of course do the reverse process in the `remove` script).
|
||||
|
||||
**Be careful** : For security reason, the script is executed as **admin** user in YunoHost. Be sure to test it as **admin** and prepend `sudo` to requiring commands.
|
||||
**Be careful** : For security reasons, the script is executed as the **admin** user in YunoHost. Be sure to test it as **admin** and prepend `sudo` to commands that require it.
|
||||
|
||||
### Architecture and arguments
|
||||
Since YunoHost has a unified architecture, you will be able to guess most of the settings you need. But if you need variable ones, like domain or web path to configure your app, you will have to ask the administrator at installation (see `arguments` section in the manifest above).
|
||||
Since YunoHost has a unified architecture, you will be able to guess most of the settings you need. But if you need variable ones, like the domain or web path, you will have to ask the administrator at installation (see `arguments` section in the manifest above).
|
||||
|
||||
**Note**: The arguments will be passed in the manifest's order to the script. For example for **roundcube**, the `domain` argument will be referenced as `$1` in the script, and `path` as `$2`.
|
||||
**Note**: The arguments will be passed in the order that they appear in the manifest. For example for **roundcube**, the `domain` argument will be referenced as `$1` in the script, and `path` as `$2`.
|
||||
|
||||
### Hooks
|
||||
YunoHost provides a hook system which consist in packager's script callbacks in the moulinette (CLI).
|
||||
The scripts has to be placed in the `hooks` repository at the root of the YunoHost package, and has to be named `priority-hook_name`, for example: `hooks/50-post_user_create` will be executed after each user creation.
|
||||
YunoHost provides a hook system, which is accessible via the packager's script callbacks in moulinette (CLI).
|
||||
The scripts have to be placed in the `hooks` repository at the root of the YunoHost package, and must be named `priority-hook_name`, for example: `hooks/50-post_user_create` will be executed after each user creation.
|
||||
|
||||
**Note**: `priority` is optional, default is `50`.
|
||||
|
||||
Take a look at the [OwnCloud package](https://github.com/Kloadut/owncloud_ynh) for a working example.
|
||||
Take a look at the [ownCloud package](https://github.com/Kloadut/owncloud_ynh) for a working example.
|
||||
|
||||
### Helpers
|
||||
The CLI [moulinette](#/moulinette) provides a few tools to make the packager's work easier:
|
||||
|
|
@ -143,7 +143,7 @@ The CLI [moulinette](#/moulinette) provides a few tools to make the packager's w
|
|||
sudo yunohost app checkport <port>
|
||||
```
|
||||
<blockquote>
|
||||
This helper checks the port and return an error if the port is already in use.
|
||||
This helper checks the port and returns an error if the port is already in use.
|
||||
</blockquote>
|
||||
|
||||
<br>
|
||||
|
|
@ -174,7 +174,7 @@ This helper is useful for web apps and allows you to be sure that the web path i
|
|||
sudo yunohost app initdb <db_user> [ -p <db_pwd> ] [ -s <SQL_file> ]
|
||||
```
|
||||
<blockquote>
|
||||
This helper creates a MySQL database. If you do not append a password, it generates one and returns it. If you append a SQL file, it initializes you database with the SQL statements inside.
|
||||
This helper creates a MySQL database. If you do not append a password, it generates one and returns it. If you append a SQL file, it initializes your database with the SQL statements inside.
|
||||
</blockquote>
|
||||
|
||||
<br>
|
||||
|
|
@ -186,13 +186,13 @@ sudo yunohost app ssowatconf
|
|||
This helper reloads the SSO configuration. You have to call it at the end of the script when you are packaging a web app.
|
||||
</blockquote>
|
||||
|
||||
### Test it !
|
||||
In order to test your app package, you can execute your script standalone as `admin` (do not forget to append required arguments):
|
||||
### Test it!
|
||||
In order to test your package, you can execute your script standalone as `admin` (do not forget to append required arguments):
|
||||
```bash
|
||||
su - admin -c "/bin/bash /path/to/my/script my_arg1 my_arg2"
|
||||
```
|
||||
|
||||
Or you can use the moulinette:
|
||||
Or you can use moulinette:
|
||||
```bash
|
||||
yunohost app install /path/to/my/app/package
|
||||
```
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue