---

Planar is an enterprise scheduler service. It’s providing peripheral tools and infrastructure to met all of schedule jobs needs (small to enterprise systems).
Scheduler engine is based on Quartz.NET

Below you can see the main key features of Planar:

Get Started

You can host and manage Planar directly on your pc by using Docker.

Docker is an open source containerization platform. It enables developers to package applications into standardized executable components called containers

1. Create an installation folder called Planar for deployment and data storage.

2. cd into the installation folder.

3. Download the docker-compose.yml file and place it into the Planar installation folder.

4. Start the Docker container by running the command below.¹²

   docker-compose -p planar up -d

---

Test The Installation

1. Open terminal or command line

2. Connect to service container shell by running the command below

   docker exec -it planar-service sh

3. Run the Planar CLI by running the command below

   planar-cli

4. The following CLI welcome screen should appear

5. Run trace ls command in Planar CLI to see list of logs
6. Open http://localhost:2306 to get the api documentation.
7. Open http://localhost:2306/swagger to get swagger page

What next?

Follow the Write Your First Planar Job WiKi documatation to create, test, deploy & invoke your first planar job.

---

Footnotes

1. This may need to be run with sudo if docker and docker-compose aren't accessible by the user. ↩

2. If the image doesn't exist locally, this command downloads the necessary Docker image and starts the container. ↩