Skip to content

Commit 4bfef4c

Browse files
authored
Docker compose instructions for users, referral to Documentation (#42)
1 parent 15aa165 commit 4bfef4c

File tree

1 file changed

+18
-2
lines changed

1 file changed

+18
-2
lines changed

README.md

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,21 @@
1-
# Custom Project
2-
This repo is a template for custom projects; showing the recommended project structure and including `README` files in the `deployment` directory to provide details about how to customise each part.
1+
# OpenRemote Custom Project Template
2+
3+
This repository is a template for custom projects; showing the recommended project structure and including `README` files in the `deployment` directory to provide details about how to customise each part.
4+
5+
## Documentation
6+
7+
The OpenRemote documentation contains more information about how to use this repository as a template to develop your own agents, services, model classes, setup tasks, tests, and new UI apps, including examples you could use as a starting point.
8+
9+
**[You can find the documentation here](https://docs.openremote.io/docs/user-guide/deploying/custom-deployment/)**.
10+
11+
## Docker Compose Files
12+
13+
In the `profile` directory you can find different Docker compose files, each serving a different purpose. To be able to use them, you'll need to download a copy of the `deploy.yml` file from the main OpenRemote repository and place it in the `openremote/profile` directory, to ensure you always have the latest version of the file:
14+
15+
```bash
16+
mkdir -p openremote/profile && curl -L https://github.com/openremote/openremote/raw/refs/heads/master/profile/deploy.yml -o openremote/profile/deploy.yml
17+
```
18+
319

420
## Setup Tasks
521
The following `OR_SETUP_TYPE` value(s) are supported:

0 commit comments

Comments
 (0)