yunohost/README.md

YunoHost

YunoHost is an operating system aiming to simplify as much as possible the administration of a server.

This repository corresponds to the core code of YunoHost, mainly written in Python and Bash.

• Project features
• Project website
• Install documentation
• Issue tracker

Screenshots

Webadmin (Yunohost-Admin)	Single sign-on user portal (SSOwat)

Contributing

• You can learn how to get started with developing on YunoHost by reading this piece of documentation.
• Come chat with us on the dev chatroom !
• You can help translate YunoHost on our translation platform

Repository content

• YunoHost core Python 2.7 scripts.
• An actionsmap describing the CLI and API
• Services configuration templates.
• Hooks.
• Locales for translations of yunohost command.
• Shell helpers for application packaging.
• Modules for the XMPP server Metronome.
• Debian files for package creation.

How does it work?

• Python core scripts are accessible through two interfaces thanks to the moulinette framework:
  • the CLI corresponding to the yunohost command.
  • the API used by the web administration interface (other interfaces could be implemented).
• You can find more details about how YunoHost works on this documentation (in French).

License

As other components of YunoHost, this repository is licensed GNU AGPL v3.