Skip to content

Getting Started

kay edited this page Nov 22, 2024 · 15 revisions

You can download the Lodestone client from our release page.

We also have a webapp for remote access.

For any troubleshooting, see our wiki.

For developers, check out the Setup guide for developers.

How to create a server

After opening Lodestone, click on Setup Lodestone Core. setup lodestone

Select an existing core; press continue and complete the signup/login procedures. setup lodestone

In the dashboard, click on New instance. setup lodestone

Pick the instance you would like to use. setup lodestone

Complete the configurations for the server.

Congratulations, you have created your first server!

How to start a server

In your dashboard, click the server you would like to start setup lodestone

Click the power button beside the server name on the left panel, and press Start. setup lodestone

Congratulations, you have started your server!

How to setup lodestone using docker

⚠️ WARNING: Docker instances do not work while running lodestone within docker.

First make sure docker is installed. If it's not you can check here if your os is supported and how to install it.

Downloading and running the container

Open your preferred terminal and run the following command:

docker run -d --name lodestone --restart unless-stopped -p 16662:16662 -v lodestone:/home/user/.lodestone ghcr.io/lodestone-team/lodestone_core

This will download the lodestone image, expose port 16662 on your system and create and use a volume so lodestone can store its data like instances.
You will probably also want to open port 25565 for minecraft, This can be done by adding -p 25565:25565 to the command.
If you did that it should look something like this:

docker run -d --name lodestone --restart unless-stopped -p 16662:16662 -p 25565:25565 -v lodestone:/home/user/.lodestone ghcr.io/lodestone-team/lodestone_core

Now you can run docker logs lodestone to access the logs and get your setup key. This will be important later.

It should be noted that when doing this on a linux system you will need to run all docker commands with sudo. This is done by just typing sudo before the command.

Accessing the dashboard

When hosting lodestone on your current system

Go to https://lodestone.cc, Click on connect a new core and enter localhost in the Ip address input.

When hosting lodestone on a system on your network

Get the local ip of that system. If this is a windows system you can run ipconfig in a terminal and look for something that starts with 192.
If its a linux system you can run ifconfig in a terminal and look for something that starts with 192.
Then go to https://lodestone.cc, Click on connect a new core and enter the ip you got from the command in the Ip address input.

When hosting lodestone on a system outside of your network

Get the public ip of the system. If you are renting a server this is probably somewhere on the dashboard.
If you cannot find it you can run curl ifconfig.me in the terminal (does not matter what os you are running) and get the ip from there.
Then go to https://lodestone.cc, Click on connect a new core and enter the ip you got from the command in the Ip address input.

Then enter your username, setup key you got from the logs, and a password.

Make sure not to use autofill since it sees the setup key input as a password input.
When saving your credentials, check the password it says it's saving. It will most likely be your setup key and not your password.