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.

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

Update Docker README #6581

Merged
merged 1 commit into from
May 25, 2022
Merged

Update Docker README #6581

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
16 changes: 8 additions & 8 deletions docker/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
# Welcome to the Docker Installation Guide for Open Library Developers

## Prerequisites & Troubleshooting

Before attempting to build openlibrary using the Docker instructions below, please follow this checklist. If you encounter an error, this section may serve as a troubleshooting guide:

- Install `docker-ce`: https://docs.docker.com/get-docker/ (tested with version 19.*)
- Install `docker-compose`: https://docs.docker.com/compose/install/
- Make sure you `git clone` openlibrary using `ssh` instead of `https` as git submodules (e.g. `infogami` and `acs`) may not fetch correctly otherwise. You can modify an existing openlibrary repository using `git remote rm origin` and then `git remote add origin git@github.com:internetarchive/openlibrary.git`

## Setup/Teardown Commands

### For Windows Users Only
Expand All @@ -23,14 +31,6 @@ Please use [Docker Desktop >= 4.3.0](https://docs.docker.com/desktop/mac/release

If you are experiencing issues building JS, you may need to increase the RAM available to Docker. The defaults of 2GB ram and 1GB Swap are not enough. We recommend requirements of 4GB ram and 2GB swap. This resolved the error message of `Killed` when running `build-assets`.

### Prerequisites & Troubleshooting

Before attempting to build openlibrary using the Docker instructions below, please follow this checklist. If you encounter an error, this section may serve as a troubleshooting guide:

- Install `docker-ce`: https://docs.docker.com/get-docker/ (tested with version 19.*)
- Install `docker-compose`: https://docs.docker.com/compose/install/
- Make sure you `git clone` openlibrary using `ssh` instead of `https` as git submodules (e.g. `infogami` and `acs`) may not fetch correctly otherwise. You can modify an existing openlibrary repository using `git remote rm origin` and then `git remote add origin git@github.com:internetarchive/openlibrary.git`

### For All Users
All commands are from the project root directory:

Expand Down