Skip to content

Latest commit

 

History

History
55 lines (40 loc) · 2.88 KB

README.md

File metadata and controls

55 lines (40 loc) · 2.88 KB

logo

Docker Hub Pulls Docker Image Size Layers

Yacht

Yacht is a container management UI with a focus on templates and 1-click deployments.

Demo:

Tempaltes

Installation:

Currently only linux has been verified as working but we are open to the idea of supporting windows eventually as well.

Keep in mind, this is an alpha so the risk of data loss is real and it may not be stable

Installation documentation can be found here.

Check out the getting started guide if this is the first time you've used Yacht: https://yacht.sh/Installation/gettingstarted/

Features So Far:

  • Vuetify UI Framework
  • Basic Container Management
  • Template Framework
  • Easy Template Updating
  • Centralized settings for volume management and similar QOL functionality.

Planned Features:

  • Advanced Container Management (Edit/Modify)
  • Container Monitoring
  • Docker-Compose Compatibility
  • Easy access to container interfaces
  • User Management

If you want something that's not planned please open a feature request issue and we'll see about getting it added.

Templating:

Currently Yacht is compatible with portainer templates. You'll add a template url in the "Add Template" settings. The the template will be read, separated into apps, and imported into the database. The apps associated with the templates are linked via a db relationship so when the template is removed, so are the apps associated with it. We store the template url as well so we can enable updating templates with a button press.

We recommend starting with:

https://raw.githubusercontent.com/SelfhostedPro/selfhosted_templates/yacht/Template/template.json

In templates you are able to define variables (starting with !) to have them automatically replaced by whatever variable the user has set in their server settings (ie. !config will be replaced by /yacht/AppData/Config by default).

Notes for ARM devices

If you're on arm and graphs aren't showing up add the following to your cmdline.txt:

cgroup_enable=cpuset cgroup_enable=memory cgroup_memory=1

License

MIT License