Skip to content
This repository has been archived by the owner on Jul 16, 2023. It is now read-only.

Commit

Permalink
docs: update README
Browse files Browse the repository at this point in the history
  • Loading branch information
ericswpark committed Jul 16, 2023
1 parent 4a556f9 commit 5110019
Showing 1 changed file with 1 addition and 29 deletions.
30 changes: 1 addition & 29 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,31 +1,3 @@
# shipper-docker
[![Release Docker image](https://github.com/shipperstack/shipper-docker/actions/workflows/release-docker-image.yml/badge.svg)](https://github.com/shipperstack/shipper-docker/actions/workflows/release-docker-image.yml)

Repository housing files to create/build/run Docker images of the shipper platform


## Installation

Run:

```
docker-compose up -d --no-build
```

## Build

Run:

```
docker-compose -f docker-compose.dev.yml up -d --build
```

## Documentation

Detailed documentation [is available here.](docs/)

## Warning

Do not run the production environment and the development environment from the same directory. Docker Compose uses the folder name as a prefix for the containers that are created, which can potentially cause a conflict. As a result, you may end up destroying a set of containers from one environment when settting up the set of containers for the other environment!

If you *must* use the same directory for both environments, consider prefixing your Docker Compose commands with `COMPOSE_PROJECT_NAME` in order to change the prefix used. (Or, export the environment flag before running Docker Compose commands.)
This repository has been deprecated! Use the main `shipper` repository.

0 comments on commit 5110019

Please sign in to comment.