Skip to main content

Quickstart

This guide will get you up and running with a local instance of the EPOS Platform in just a few minutes. By the end, you'll have a fully functional data catalogue populated with sample data.

Prerequisites​

Before you begin, make sure you have the following installed and running:

  • Docker: The EPOS Platform runs in containers, so you'll need Docker. Learn how to install Docker.
  • System Requirements: At least 4GB of RAM, 2 CPU cores, and 10GB of free storage.
  • A command-line terminal: The installation is done via the command line.

1. Install the EPOS CLI​

First, you need to install the epos-opensource command-line interface (CLI). This tool will handle the deployment and management of your platform. Choose the tab for your operating system below.

You can install the CLI with a single command in your terminal:

curl -fsSL https://raw.githubusercontent.com/EPOS-ERIC/epos-opensource/main/install.sh | bash

To make sure it's installed correctly, open a new terminal and run:

epos-opensource --version

You should see an output like epos-opensource version v1.0.0 (the version number may vary).

For more detailed installation instructions, including how to build from source, see the CLI Tool documentation.

Updating the CLI​

To keep your CLI up to date, you can use the update command. It is the recommended way to get the latest version.

epos-opensource update

2. Deploy the Platform​

Now, with Docker running, you can deploy the entire EPOS Platform with a single command. Choose a name for your platform instance (e.g., my-epos-platform).

Launch the interactive TUI:

epos-opensource

TUI Home

Click on the Create New Environment in the Docker Environments section.

Deploy Nen Environment

Enter your environment name (e.g., my-epos-platform) and confirm to start the deployment.

The TUI will show progress as Docker images are downloaded and services start.

TUI Deploy Progress

3. Populate with Sample Data​

To see your platform in action, you can populate it with some example metadata we provide. This will create a few example entries in your data catalogue.

Navigate to a deployed environment details by clicking on it

TUI Env Details

Here you can perform different actions on a deployed environment and see its options/status. As you can see in the Ingested Files section there is nothing, let's add data to our environment. Press on the Populate button

Populate with TUI

Here you can specify the paths to directories or files to ingest. There also is the possibility to populate an environment with some pre provided example data, to do this, check the Populate Examples checkbox and proceed with the population by clicking on Populate.

warning

There is a known issue with the system where sometimes populated data might not show up immediatly. We are aware of this and currently working on a fix. In the meantime you can easily fix it by simply restarting the resources-service container.

Try running:

docker restart my-epos-platform-resources-service

Remember to change my-epos-platform with the name you used when deploying the environment.

If that doesn't work feel free to open an issue on GitHub.

For more solutions to common issues, please see our Troubleshooting Guide.

4. Explore Your New Platform​

Congratulations, your EPOS Platform is live!

Open your web browser and go to the EPOS Platform GUI provided at the end of the deployment step. Or if you are using the TUI by clicking on the Open button near the GUI url. The default URL is http://localhost:32000/.

The EPOS Platform

You should see the main interface for browsing and searching for geospatial services. The sample metadata will appear on the top-left side of the interface.

You can also explore the API Documentation at http://localhost:33000/api/v1/ui.

Next Steps​

Now that you have a running instance, you can: