Skip to content

Latest commit

 

History

History
51 lines (44 loc) · 2.76 KB

README.md

File metadata and controls

51 lines (44 loc) · 2.76 KB
Raw

Webit Cloud Services Toolkit (WBcloud)

This is an extensible framework to set up and to maintain a complex system of microservices (e.g. database, Web server, PHP, LDAP, Unix shell, cloud storage etc.) behind an automatically configured proxy (Traefik). It uses Docker to deploy the services.

Features:

  • provides text- and a Web-based GUIs to manage services
  • allows to reconfigure the system on-the-fly without rebuilding and restarting unaffected Docker containers
  • keeps all you data and configuration files independently from their service containers
  • automatically configures the Web proxy according to the actual set of running services (you can specify individual service URLs)
  • requests and renews HTTPS certificates automatically
  • easy to extend with new dockerized services, even using Dockerfiles
  • supports easy backup and migration to a new location

Installation

Select a target directory (e.g. /srv) where service configuration and data files will be stored.
Get the source and start the deplopment utility:

git clone https://github.com/mtwebit/webit-cloud-services.git
cd webit-cloud-services
./wbsetup.sh

The deployment tool will install the necessary dependencies and start a menu-driven setup utility to deploy and configure the services.

System management

You can reconfigure your system by running the deployment utility again or via the Web Admin UI.
To uninstall a service simply remove its container (using "docker rm" or the Web UI).

Services

  • LDAP authentication and Keycloak IdP
  • automatically configured Web proxy (Traefik)
  • Autoupdater (Watchtower)
  • Cloud Storage (Nextcloud with LDAP auth)
  • Web-based office suite (OnlyOffice)
  • Remote shell in a Browser (using WeTTy and LDAP auth)
  • PHP-enabled Web server
  • Databases: Mariadb, MongoDB, Redis
  • Search engine: Solr
  • Web-based management UI: Portainer
  • more...
  • Your own service, see the Hello World example

How does it work

Services are installed as Docker containers and they are connected to each other using an internal docker network.
The framework uses container labels to automatically configure the Web proxy and the autoupdate tool.
See the Wiki for more details.

Bugs & Support

The framework has been used in several projects so it is considered fairly stable.
If you encounter a bug or missing a feature in the framework create an issue or a pull request.

Services are generally not supported.
They are tested during their integration and you can expect that common services (like Mariadb, PHP Web, Cloud Storage) will work well, but there is no guarantee.