diff --git a/README.md b/README.md index ac285a9c4..dfd9daf4f 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,10 @@ # Stratos -  - - -[![GitHub release](https://img.shields.io/github/release/cloudfoundry/stratos.svg)](https://github.com/cloudfoundry/stratos/releases/latest) -[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://github.com/cloudfoundry/stratos/blob/master/LICENSE) +  + + +[![GitHub release](https://img.shields.io/github/release/cloudfoundry-community/stratos.svg)](https://github.com/cloudfoundry-community/stratos/releases/latest) +[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/cloudfoundry-community/stratos/blob/master/LICENSE) [![slack.cloudfoundry.org](https://slack.cloudfoundry.org/badge.svg)](https://cloudfoundry.slack.com/messages/C80EP4Y57/) Stratos is an Open Source Web-based UI (Console) for managing Cloud Foundry. It allows users and administrators to both manage applications running in the Cloud Foundry cluster and perform cluster management tasks. @@ -29,7 +29,59 @@ Tested with Browserstack Browserstack +# Stratos UI pre-packager + +This feature helps in pre-building the +[Stratos](https://github.com/cloudfoundry-community/stratos) web application +so that it can be deployed faster in Cloud Foundry, or be run offline. + +You can find pre-built versions of Stratos UI in the +[releases](https://github.com/cloudfoundry-community/stratos/releases) +of this repository. + +To run those `.zip` packages inside Cloud Foundry, unzip it, write a manifest, +and `cf push` it. + +You are not required to have +[stratos-buildpack](https://github.com/SUSE/stratos-buildpack), you can use +binary buildpack. + +Here is an example app manifest that worked for us: +```yaml +applications: + - name: console + memory: 128M + disk_quota: 192M + host: console + timeout: 180 + buildpack: binary_buildpack + health-check-type: port +``` + +For best results rather than pushing manually instead use within the (Genesis CF Kit)[https://github.com/genesis-community/cf-genesis-kit] like so: +``` +genesis do stratos sgs +``` +Note: `sgs` creates security groups the first time, upgrades do not use `sgs`. + +## Usage + +Golang is required, and version 1.12 is recommended as this is the version used +by the Stratos build system. + +When you want to build the `4.1.2` tag in +[Stratos UI releases](https://github.com/cloudfoundry-community/stratos/releases), +run this command: + +``` +TRAVIS_TAG=4.1.2 ./package.sh +``` + +### NOTE +The original code for this feature can be found in the [Orange Cloud foundry Github Repository](https://github.com/orange-cloudfoundry/stratos-ui-cf-packager/). +Many thanks to Benjamin & Arthur, we appreciate you both! + ## License -The work done has been licensed under Apache License 2.0. The license file can be found [here](LICENSE). +The work done has been re-licensed under MIT License. The license file can be found [here](LICENSE).