Benature/omnivore
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Change docker-compose to docker compose in docs

Browse Source
This commit is contained in:
Jackson Harper
2023-06-22 10:24:51 +08:00
parent a0556055c5
commit 686bc22467
2 changed files with 23 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
packages/api/README.md
View File

@ -20,13 +20,13 @@ Because we make use of Row Level Security in the database, - all operations typi
We use ElasticSearch to store page data in a distributed manner. This is a great way to store data that is not easily searchable.
All the page data is stored in a single index `pages`. This index is then queried by the app to display the data.
You need to make sure you have an elasticsearch instance running locally (or just use docker-compose).
You need to make sure you have an elasticsearch instance running locally (or just use docker compose).
ES url is specified by `ES_URL` environment variable (username `ES_USERNAME` and password `ES_PASSWORD` can be random strings in local environment).
When you're running elastic for the very first time, you need to create indices and ingest existing data. This can be done by running `python elastic_migrate.py`.
This operation is idempotent, so you can always run `python elastic_migrate.py` again to re-ingest all the data.
You can run ElasticSearch separately by using `docker-compose -f docker-compose.yml up -d elastic`.
You can run ElasticSearch separately by using `docker compose -f docker-compose.yml up -d elastic`.
## Image Proxy (optional for local dev)
@ -36,16 +36,18 @@ to a running instance of image proxy along with env var IMAGE_PROXY_SECRET. The
same secret env var ought to be passed as config to the running image proxy
service. You can also use the docker-compose-dev.yml file to bring up just the
image proxy service alone (w/ env var for secret specified in the compose file)
by running: ```docker-compose -f docker-compose-dev.yml up -d imageproxy```.
by running: `docker compose -f docker-compose-dev.yml up -d imageproxy`.
When running locally, use the .env.local file to set up the env variables in your environment.
### Set up the database
Refer the [using locally](../db/README.md#using-locally) section from db README.
### Copy .env.example file to .env file:
cp .env.example .env
### Run the app
yarn dev