https://github.com/chartmuseum/ui
ChartMuseum frontend UI
https://github.com/chartmuseum/ui
chartmuseum charts helm kubernetes
Last synced: 5 months ago
JSON representation
ChartMuseum frontend UI
- Host: GitHub
- URL: https://github.com/chartmuseum/ui
- Owner: chartmuseum
- Created: 2018-08-27T11:03:50.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-07-11T13:06:15.000Z (almost 3 years ago)
- Last Synced: 2025-06-13T22:01:47.232Z (about 1 year ago)
- Topics: chartmuseum, charts, helm, kubernetes
- Language: Smarty
- Homepage:
- Size: 31 MB
- Stars: 116
- Watchers: 6
- Forks: 43
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# ChartMuseumUI
[](http://hits.dwyl.io/idobry/chartmuseumui) [](https://github.com/dwyl/esta/issues) [](https://goreportcard.com/report/github.com/chartmuseum/ui)
# ChartMuseumUI
ChartMuseumUI is a simple web app that (currently) provides GUI for your charts so you and your team can view and share the technologies your are using to any one at any time (in near future more capabilities will be added).
ChartMuseumUI was written in Go (Golang) with the help of Beego Framework.
## Getting Started
These instructions will get you started with your very own private chart repository and UI.
### Usage
ChartMuseumUI uses [ChartMuseum](https://github.com/helm/chartmuseum) as a backend.
To get started quickly, you can build and run the app using docker-compose.
Clone this repo and run the following:
```
docker-compose up
```
This will start ChartMuseumUI at [http://localhost:3000](http://localhost:3000)
and ChartMuseum at [http://localhost:8080](http://localhost:8080).
Check out the source of [docker-compose.yaml](./docker-compose.yaml) and modify for your purposes.
Here is an example docker-compose file defining ChartMuseum with Amazon S3 as a storage and exposing ChartMuseumUI on port 80:
```
version: '2.0'
services:
ui:
image: idobry/chartmuseumui:latest
environment:
CHART_MUSEUM_URL: "http://chartmuseum:8080"
ports:
- 80:8080
chartmuseum:
image: chartmuseum/chartmuseum:latest
volumes:
- ~/.aws:/root/.aws:ro
restart: always
environment:
PORT: 8080
DEBUG: 1
STORAGE: "amazon"
STORAGE_AMAZON_BUCKET: "chartmuseum-bucket"
STORAGE_AMAZON_PREFIX: ""
STORAGE_AMAZON_REGION: "eu-west-1"
ports:
- 8080:8080
```
Copy this file and run
```
docker-compose up
```
Easy, right? now, we can add our private repository to our Helm client:
```
# choose any name you like
$ helm repo add chartmuseum
$ helm repo update
# to view our repos list
$ helm repo list
NAME URL
stable https://kubernetes-charts.storage.googleapis.com
incubator http://storage.googleapis.com/kubernetes-charts-incubator
chartmuseum http://localhost:8080
```
Let's upload a chart into our private repository:
```
$ cd /chart/path
# create a chart package - this will create a .tgz file
$ helm package .
# copy packge name and run
$ curl -L --data-binary "@" /api/charts
```
In the browser, navigate to localhost and view your charts
### Using with ChartMuseum with Multitenancy enabled
To use ChartMuseumUI on a ChartMuseum with Multitenancy support enabled, add the following environment variable to ChartMuseumUI
```
CHART_MUSEUM_API_GET_CHARTS: "/api/org1/charts"
```
Currently only one organization is allowed per ChartMuseumUI.
### Adding authentication to ChartMuseumUI
To add a simple basic auth to ChartMuseumUI, you can add the following configuration
```
BASIC_AUTH_USERS: '[{"username":"admin", "password":"password"}, {"username":"user", "password":"s3cr3t"}]'
```
## Built With
* [beego](https://beego.me/) - The web framework used
* [go](https://golang.org/) - Programing language
* [docker](https://www.docker.com/) - Packaged with docker
## Project Roadmap
* Add login screen
* Add more chartmuseum capabilitis:
- Upload a chart
- Support multiple
- Delete a chart
- Ask before deleting
- Delete all versions button
- Back to 'home' after delete all
## Contributing
Code contributions are very welcome. If you are interested in helping make chartmuseumui great then feel free!
## Authors
* **Ido Braunstain** - *Initial work*
See also the list of [contributors](https://github.com/idobry/contributors) who participated in this project.