An open API service indexing awesome lists of open source software.

https://github.com/hjmcnew/portainer-docker-compose

Portainer EE docker compose files
https://github.com/hjmcnew/portainer-docker-compose

docker docker-compose docker-compose-files portainer portainer-ee

Last synced: 12 months ago
JSON representation

Portainer EE docker compose files

Awesome Lists containing this project

README

          

# Portainer Docker Compose

This repository provides a simple setup to deploy Portainer using Docker Compose. Portainer is a lightweight management UI that allows you to easily manage your Docker environments.

## Table of Contents

- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Configuration](#configuration)
- [Contributing](#contributing)
- [License](#license)

## Getting Started

These instructions will help you get a copy of the project up and running on your local machine for development and testing purposes.

### Prerequisites

Before you begin, ensure you have met the following requirements:
- Docker installed on your machine. You can download Docker from [here](https://www.docker.com/products/docker-desktop).
- Docker Compose installed. You can follow the instructions [here](https://docs.docker.com/compose/install/).

## Installation

1. Clone the repository:

```sh
git clone https://github.com/hjmcnew/portainer-docker-compose.git
cd portainer-docker-compose
```

2. Start the Portainer service using Docker Compose:

```sh
docker-compose up -d
```

3. Access Portainer UI by navigating to `http://localhost:9443` in your web browser.

## Usage

- Once Portainer is running, you can log in and start managing your Docker environments.
- You can add multiple Docker endpoints and manage them from a single interface.

## Configuration

- The default configuration can be modified in the `docker-compose.yaml` file.
- You can change the exposed ports, volume mounts, and other settings as needed.

## Contributing

Contributions are always welcome! Please follow these steps to contribute to the project:

1. Fork the repository.
2. Create a new branch (`git checkout -b feature/your-feature-name`).
3. Make your changes.
4. Commit your changes (`git commit -m 'Add some feature'`).
5. Push to the branch (`git push origin feature/your-feature-name`).
6. Open a Pull Request.

## License

This project is licensed under the BSD License - see the [LICENSE](LICENSE) file for details.