Skip to content

LIBBCM-119. Removing BCM development instructions. #14

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
mohideen wants to merge 1 commit into
base: bcm-develop
Choose a base branch
from
Open

LIBBCM-119. Removing BCM development instructions. #14

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 0 additions & 77 deletions BCM-README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,82 +1,5 @@
# bcm-avalon-docker

### Developing for Broadcast Avalon using Docker

1. Checkout [avalon](https://github.com/umd-lib/avalon) next to the avalon-docker directory.
In avalon, change the config/setting.yml redis settings to:

```
redis:
host: redis
port: 6379
```

2. Copy config files from avalon-docker to avalon:

```
cp avalon-docker/avalon/config/* avalon/config/
```

3. Copy the `controlled_vocabulary.yml.example` file to `controlled_vocabulary.yml`

```
cp avalon/config/controlled_vocabulary.yml.example avalon/config/controlled_vocabulary.yml
```

4. In avalon-docker, copy the `dotenv.example` file to `.env`:

```
cd avalon-docker
cp dotenv.example .env
```

and fill out the entries in the file.

Example values for `.env` required settings

```
# Required Settings
APP_NAME=avalon
BASE_URL=http://localhost:3000/
STREAMING_HOST=localhost
AVALON_DB_PASSWORD=avalon
FEDORA_DB_PASSWORD=fedora
SECRET_KEY_BASE=cd19c21931892c5ab2bf630f51dcb96ec8c869029123ce91614f2d1708b95410d4d58f4b9d4fcef0ea37e386ad56e9259dc7258818a7a71c65b2037561be30c8
AVALON_BRANCH=bcm-docker
```

**Note:** Some lines may need to be added.

5. Get the images from Dockerhub:

```
docker-compose -f docker-compose-dev.yml pull
```

6. Ensure that these directories are configured to be mountable by Docker containers:
* avalon
* avalon-docker/gems
* avalon-docker/masterfiles

**Docker Community Edition of Mac OS X:** Click the Docker icon in the system
menubar, select *Preferences...* then *File Sharing*. Add the full paths to the
directories listed above, then click *Apply & Restart*.

7. Bring up the stack:

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

8. After the Avalon container is fully up, it will pick up changes in the avalon directory

9. Access the shell in the Avalon docker container:

```
docker exec -it avalon-docker_avalon_1 /bin/bash
```


### Creating BCM Docker Images for AWS

Avalon uses some of the native AWS services in place of services such as Redis,
Expand Down