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

Fix typo / wording

Browse source
This commit is contained in:
Alexandre Aubin 2018-08-26 17:47:18 +02:00 • committed by GitHub
parent 9b926559ce
commit f1a96a907f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
packaging_apps.md
View file

@ -48,18 +48,19 @@ Take a look at the [ownCloud package](https://github.com/Kloadut/owncloud_ynh) f
### Helpers ### Helpers
<a class="btn btn-lg btn-default" href="packaging_apps_helpers_en">Helpers</a> <a class="btn btn-lg btn-default" href="packaging_apps_helpers_en">Helpers</a>
### Register a log ### Registering a log file
In a lot of case, you could want to register log file created by your app, to display it in YunoHost webadmin. To register a log, you can create a reference file in /var/log/yunohost/categories/app/APPNAME.yml
You can specify started date by begining the file name by the date formatted as YYYYMMDD-HHMMSS. In a lot of case, you might want to register a log file created by your app, to make it available in the webadmin. To register a log, you can create a reference file `/var/log/yunohost/categories/app/APPNAME.yml`.
Example of yml metatdata log file: You can specify a start date by starting the file name with the date formatted as `YYYYMMDD-HHMMSS`.
```
Example of yml metadata log file:
```bash
log_path: /path/to/your/log/file.log log_path: /path/to/your/log/file.log
``` ```
If you want display some context info, you can add : If you want display some context info, you can add:
``` ```bash
extra: extra:
env: env:
args1: value1 args1: value1
@ -67,15 +68,16 @@ extra:
args3: value3 args3: value3
``` ```
You can attach the domain to an app, domain, service or user like this : You can attach the log to an app, domain, service or user like this :
``` ```bash
related_to: related_to:
- ['app', 'APPNAME'] - ['app', 'APPNAME']
- ['service', 'SERVICE1'] - ['service', 'SERVICE1']
- ['service', 'SERVICE2'] - ['service', 'SERVICE2']
- ['domain', 'DOMAIN.TLD'] - ['domain', 'DOMAIN.TLD']
``` ```
This will be used to filter logs and display all log related to an entity lika a user, a domain, an app or a service.
This will be used to filter logs and display all log related to an entity like a user, a domain, an app or a service.
### Test it! ### Test it!
In order to test your package, you can execute your script standalone as `admin` (do not forget to append required arguments): In order to test your package, you can execute your script standalone as `admin` (do not forget to append required arguments):