-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
31 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,53 +1,54 @@ | ||
This template is intended to facilitate the set-up of a brand new ORR instance. | ||
# orr-instance-template | ||
|
||
Only requirements on your target machine are | ||
This small repository is a template intended to facilitate the | ||
set-up of a brand new ORR instance. | ||
|
||
Only requirements on your target machine are | ||
[Docker Engine](https://docs.docker.com/engine/installation/) | ||
and [Docker Compose](https://docs.docker.com/compose/install/). | ||
If your target machine is MacOS or Windows, you only need to have | ||
Docker Engine installed as it includes Docker Compose. | ||
|
||
With this template you can focus on the needed configuration | ||
and let Docker take care of pulling the service images | ||
With this template you can focus on the needed configuration | ||
and let Docker take care of pulling the service images | ||
and launching your ORR instance. | ||
|
||
The steps are: | ||
The more detailed install documentation is available at | ||
https://mmisw.org/orrdoc/install/. In a nutshell, the steps are: | ||
|
||
### Get the template | ||
|
||
Download the latest template version from | ||
Download the latest template version from | ||
https://github.com/mmisw/orr-instance-template/releases, | ||
expand the tarball on your target machine | ||
expand the tarball or zip file on your target machine | ||
and `cd` to the home directory there. | ||
|
||
Or, if you have a Git client: | ||
> Or, if you have a Git client: | ||
> | ||
> git clone https://github.com/mmisw/orr-instance-template.git myORR | ||
> cd myORR | ||
> rm -rf .git | ||
### Environment variables | ||
|
||
git clone https://github.com/mmisw/orr-instance-template.git myORR | ||
cd myORR | ||
rm -rf .git | ||
### Environment variables | ||
`setenv.sh` can be used to define a number of environment variables | ||
`setenv.sh` can be used to define a number of environment variables | ||
that are used in later steps: | ||
|
||
- Edit `setenv.sh` to review and adjust the variables as needed. | ||
- On the command line, "source" `setenv.sh` to expose the variables to the | ||
environment: `$ source setenv.sh` | ||
|
||
vi setenv.sh | ||
source setenv.sh | ||
|
||
### Configuration | ||
Edit `config/orront.conf`, the master configuration for your ORR instance. | ||
|
||
Also, optionally, edit `config/notifyemails`. | ||
|
||
### Configuration | ||
|
||
- Edit `config/orront.conf`, which is the master configuration for your ORR instance. | ||
- Optionally, edit `config/notifyemails`. | ||
|
||
### Launching | ||
|
||
`docker-compose.yml` specifies the services comprising the ORR system. | ||
No changes are typically needed in this file unless otherwise | ||
indicated in ORR documentation, release notes, or other communications. | ||
indicated in ORR documentation, release notes, or other communications. | ||
|
||
Launch the ORR system: | ||
|
||
docker-compose up -d | ||
|
||
### Documentation | ||
|
||
More comprehensive install documentation is available at | ||
https://mmisw.org/orrdoc/install/. |