![Yacht]()
Yacht
Container
A web interface for managing docker containers with an emphasis on templating to provide 1 click deployments. Think of it like a decentralized app store for servers that anyone can make packages for.
Image details
Configuration
TypeContainerlinuxselfhostedpro/yacht:latest8001:8000/tcp/config : yacht/var/run/docker.sock : /var/run/docker.sockunless-stoppedTemplate by novaspirit
Notes
Check our Github page: https://github.com/pi-hosted/pi-hosted
Official Webpage: https://yacht.sh/
Official Docker Documentation: https://yacht.sh/docs/Installation/Install#via-docker-compose
Standalone Install
Select an install method, to see config/commands for deploying Yacht
Install on Portainer
Import all app templates into your Portainer instance, for easy 1-click deploys
- Ensure both Docker and Portainer are installed, and up-to-date
- Log into your Portainer web UI
- Under Settings → App Templates, paste the below URL
- Head to Home → App Templates, and the list of apps will show up
- Select Yacht, fill in any config options, and hit Deploy
Template Import URL
https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me
More install options in our documentation, or see selfhostedpro/yacht for app-specific guidance.
Yacht
Yacht is a container management UI with a focus on templates and 1-click deployments.Demo:
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/
Yacht is also available via the DigitalOcean marketplace:
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.jsonIn 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=1Supported Environment Variables
You can utilize the following environment variables in Yacht. None of them are manditory.| Variable | Description |
|---|---|
| PUID | Set userid that the container will run as. |
| PGID | Set groupid that the container will run as. |
| SECRETKEY | Setting this to a random string ensures you won't be logged out in between reboots of Yacht. |
| ADMINEMAIL | This sets the email for the default Yacht user. |
| DISABLEAUTH | This disables authentication on the backend of Yacht. It's not recommended unless you're using something like Authelia to manage authentication. |
| DATABASEURL | If you want to have Yacht use a database like SQL instead of the built in sqlite on you can put that info here in the following format: postgresql://user:password@postgresserver/db |
| COMPOSEDIR | This is the path inside the container which contains your folders that have docker compose projects. (compose tag only) |
License
MIT LicenseServe Yacht on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.
Proxying yacht.example.com to http://yacht:8000
Add this to your Caddyfile
yacht.example.com {
reverse_proxy http://yacht:8000
}Check the logs first
Nine times out of ten the logs tell you exactly what went wrong.
- In Portainer, go to Containers, click the container, then Logs. Or run
docker logs yacht - Exit codes help too:
137means killed, usually out of memory.126or127means the command inside the image is broken.
Port already in use
If deployment fails with "Bind for 0.0.0.0:8001 failed: port is already allocated", something else on your server is using that port.
- Find what's using it:
sudo ss -tlnp | grep :8001 - Stop the other service, or pick a different host port. In
8001:8000only the left number is yours to change, the right one belongs to the app.
Running but the page won't load
The container is up but nothing appears in your browser.
- Use your server's real IP:
http://your-server-ip:8001. The 0.0.0.0 link Portainer shows isn't a real address. - Give it a minute after first deploy, yacht can take a while to initialise.
- Make sure your firewall allows the port, e.g.
sudo ufw allow 8001
Can't reach the Docker socket
yacht talks to Docker through /var/run/docker.sock. If the logs show
"permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.
- Check the socket exists on the host:
ls -l /var/run/docker.sock - Run the container as root, or add the docker group's id to the container with
group_add.
Image won't pull
Test the pull directly on the host: docker pull selfhostedpro/yacht:latest
- "manifest unknown" means the tag no longer exists. This template uses
latest, so try pinning a specific version instead. - "toomanyrequests" is the Docker Hub rate limit. Log in with
docker loginto raise it. - "no space left on device" means a full disk. Reclaim space with
docker system prune
"exec format error"
This means the image was built for a different CPU architecture than your server.
- This image supports:
amd64, arm64, arm/v7 - Check yours with
uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.
Container keeps restarting
The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.
- Check the logs right after a restart, the last few lines before it died are the useful ones.
- Get the exit code with
docker inspect yacht --format '{{.State.ExitCode}}' - Still stuck? Redeploy once with the restart policy set to
noso the failure stays visible.
Raise an issue
Found something which isn't working as it should? Here's how to report it.
- Bug within the app: Open an issue on selfhostedpro/yacht
- Template not working: Open an issue on novaspirit/pi-hosted
- This website not working: Open an issue on lissy93/portainer-templates
A single container
Yacht runs as one container, the simplest kind of app here. Just the one image to pull and nothing else wired up alongside it.
The app image
An image is the app packed up ready to go, everything Yacht needs bundled into one download. This template pulls selfhostedpro/yacht:latest, which Docker fetches once (about 80 MB) and then starts your own copy from.
Where the image comes from
Docker pulls its images from registries, public libraries of ready-built apps. Yacht's comes from Docker Hub, published by selfhostedpro.
Version tags
The bit after the colon in the image name is the version tag. Here it's latest, which always points at the newest build, so a redeploy can bump you to a newer release without you asking. Pin a specific tag if you would rather stay on one version.
Which machines it runs on
Every image is built for particular CPU types. This one ships for amd64, arm64, arm/v7, so it runs on both regular x86 servers and ARM boards like a Raspberry Pi.
Ports
A port is the door the app answers on. A mapping like 8001:8000 means it's reachable on port 8001 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8001 in a browser. It opens:
8001:8000, likely the web interface
Volumes
A volume is where Yacht keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:
/configkept in theyachtvolume Docker manages/var/run/docker.sockfrom/var/run/docker.sockon the host (a socket it talks to, not storage)
Restart policy
The restart policy here is unless-stopped, so Docker restarts Yacht after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).
Networking
Nothing custom is set, so Yacht sits on Docker's default bridge network: its own private space that reaches the outside world only through the ports it publishes.
Container name
Once it's deployed, Portainer names the container yacht. That's what you'll spot in the containers list and use in commands like docker logs yacht.
Platform
The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.
Open source license
Yacht is open source, released under the MIT license. In plain terms the code is out in the open, so you're free to run it and change it to fit what you need.
Portainer app templates
Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Yacht up. Add the template list to Portainer once, then deploying Yacht is a click rather than a wall of config.