Skip to content
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.

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

add a new docker compose to facilitate local dev #110

Open
wants to merge 15 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
32 changes: 32 additions & 0 deletions docker-compose.localstack.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
version: '3.8'

services:
web:
env_file: .env
environment:
- LOG_LEVEL=info
image: datacite/levriero
build: .
ports:
- "8045:80"
- "2245:22"
volumes:
- ./app:/home/app/webapp/app
- ./config:/home/app/webapp/config
- ./lib:/home/app/webapp/lib
- ./spec:/home/app/webapp/spec
platform: linux/amd64
networks:
- localstack_datacite
depends_on:
- memcached

memcached:
image: memcached:1.4.31
platform: linux/amd64
networks:
- localstack_datacite

networks:
localstack_datacite:
external: true
12 changes: 12 additions & 0 deletions nework-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
#Guide to running Levriero entirely locally

In order to enable Levriero to access the Lupo API locally we need both Lupo and Levriero to run within the same docker network.

The network is defined in the Lupo **docker-compose.network.yml** and is called **public**.

Levriero joins this network through the identifier **lupo_public**.

## Steps
1. Start the Lupo container by executing `docker compose -f docker-compose.network.yml up`

2. Start the Levriero container by executing `docker compose -f docker-compose.network.yml up`
17 changes: 17 additions & 0 deletions run-with-localstack.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
## Guide to run Levriero with local dependencies

This is a simple guide on how to run Levriero (Event Data) locally. The local setup
includes LocalStack (AWS emulation) and Lupo.

With this setup you will be able to access the Lupo API endpoints and well as access AWS
services running locally within a container.

#### Source Code
1. LocalStack (http://this.will.be.something.soon)
2. Lupo (https://github.com/datacite/lupo)
3. Levriero (https://github.com/datacite/levriero)

#### Steps
1. Start up the LocalStack container `docker compose up`
2. Start up the Lupo container `docker compose -f docker-compose.localstack.yml up`
2. Start up the Levriero container `docker compose -f docker-compose.localstack.yml up`

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.