Perhaps you like managing Cattle.
If you're on a Mac and use Homebrew, you can follow these steps:
brew install node watchman yarn
git clone 'https://github.com/rancher/ui' cd 'ui' ./scripts/update-dependencies
Run development server:
Connect to UI at https://localhost:8000/ . The server automatically picks up file changes, restarts itself, and reloads the web browser. This is intended only for development, see below for distributing customizations.
Run development server pointed at another instance of the Rancher API
RANCHER="http://rancher:8080/" yarn start
and/or pointed at another instance of the Catalog API
CATALOG="http://catalog:8088/" yarn start
RANCHER and CATALOG can also be
Compiling for distribution
Rancher releases include a static copy of the UI passed in during build as a tarball. To generate that, run:
We highly suggest making customizations as an ember-cli addon rather than forking this repo, making a bunch of changes and then fighting conflicts to keep it up to date with upstream forever. ui-example-addon-machine is an example addon that adds a custom screen for a docker-machine driver. If there is no way for you to get to what you want to change from an addon, PRs to this repo that add generalized hooks so that you can are accepted.
Rancher UI supports localization via translations files. You can swap translations live by utilizing the Language Picker located in the footer. If you would like to add your own translations files follow the directions below.
- Fork the Rancher UI repo
- Copy the
en-us.yamlfile located in
/translationsfolder and rename using the
<language-code>/<country-code>.yamlformat (Supported Locales)
- Replace the values on each key with you're new values corresponding to your language
- Ensure you replace the
languageNamevalue as this is what will be displayed in the language picker in the UI
- While developing you can use
SHFT + Lwhen not focused in an input or text area to toggle the languages between your currently selected language and a special none language to see what key values are missing
- When you've finished you're translations issue a pull request back to the Rancher UI repo to have your translation included
If you want to customize the UI, re-packaging all of Rancher to distribute the UI is possible but not terribly convenient. Instead you can change Cattle to load the UI source from a remote web server:
- Build with
./scripts/build-static -l -c 'your-server.com'
./dist/static/latest2so that it's available at https://your-server.com/latest2
- It must be available over HTTPS.
- You can rename the "latest2" part with the
- Change the value of http[s]://your-rancher:8080/v3/settings/ui-index to the same
yarn global add ember-cli
ember test --server
Bugs & Issues
Please submit bugs and issues to rancher/rancher with a title starting with
Or just click here to create a new issue.
- ember: http://emberjs.com/
- ember-cli: http://www.ember-cli.com/
- Development Browser Extensions
Copyright (c) 2014-2018 Rancher Labs, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.