Docker Instance

⚠️ WARNING: Docker Instance is WIP and is not ready for production use

Last updated for: v0.5.0

What is Docker Instance?

Docker Instance, as the name suggests, integrates Lodestone seamlessly with any Docker container.

Getting Started

Make sure you are on Lodestone Core version v0.5.0 or later, and have Docker installed on your machine.

Make sure Lodestone Core is running on the same machine as the Docker daemon. i.e. not in a Docker container.

Make sure to start the Docker daemon before running Lodestone Core.

1. Create a new docker container, note down its name

2. Go to Lodestone Core and input

   di add <container-name>

3. Go to the dashboard and refresh, you should see your container listed as a Docker Instance

To remove a Docker Instance from Lodestone (not the actual container), use di remove <container-name>

Features and Limitations

• Features:

  • Run any Docker container as a Lodestone instance
  • View all mounted volumes
  • Monitor status (running, stopped, etc)
  • View console output from container (only when starting the container from Lodestone)
  • Start, stop, restart, and kill the container from the dashboard

• Limitations:

  • Only owner can add and manage Docker Instances
  • Volumes are read-only at the moment; you cannot modify files from the Lodestone dashboard
  • No console input
  • Clicking on the "Macros" page crashes the dashboard
  • Cannot view logs from the dashboard
  • Cannot view container stats (CPU, memory, etc)
  • No ports and version information
  • No way to edit the container settings
  • Does not support Lodestone Core running in a Docker container

Keep in mind that Docker Instance is still in development, and more features will be added in the future. The above limitations are also being worked on.