Skip to content

Commit d342df6

Browse files
committed
updating docs and moving sample files into there own dir
1 parent b649f96 commit d342df6

File tree

7 files changed

+10
-18
lines changed

7 files changed

+10
-18
lines changed

docs/Creating_a_proxy_server_for_docker.md

Lines changed: 6 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,17 @@
11
# Serving with a proxy server and HTTPS
2-
By default the docker applacition doesn't come with an https server. It is also likely that you want to server other applcaitions.
2+
By default the docker application doesn't come with an https server. It is also likely that you want to server other applications.
33

4-
If you want to server the docker applciation via https or serve mutliple appcations via nginx/apache then you will also need a proxy server.
4+
If you want to server the docker application via https or serve multiple applications via nginx/apache then you will also need a proxy server.
55

6-
To change the port from which OpenEats is serverd you will need to update the left side of the port configuration.
7-
- Open the docker-prod.yml (your docker-compose configuration) file.
6+
To change the port from which OpenEats is served you will need to update the left side of the port configuration.
7+
- Open the docker-prod.override.yml (your docker-compose configuration) file.
88
- To serve the app via port 7000:
99
``` yml
10+
version: '2.3'
11+
services:
1012
nginx:
11-
image: openeats/nginx
12-
command: ./start.sh
1313
ports:
1414
- "7000:80"
15-
volumes:
16-
- static-files:/var/www/html/openeats-static/static-files
17-
- site-media:/var/www/html/openeats-static/site-media
18-
depends_on:
19-
- api
20-
- web
21-
env_file:
22-
env_prod.list
2315
```
2416
2517
- Restart you docker containers `docker-compose -f docker-prod.yml restart`

docs/Running_the_App.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@ Then, create two files from the sample files:
1515
- env_prod.list
1616

1717
```bash
18-
cp docker-prod.override.yml docs/sample_docker_prod_override.yml
19-
cp env_prod.list docs/sample_env_file.list
18+
cp docker-prod.override.yml docs/sample/sample_docker_prod_override.yml
19+
cp env_prod.list docs/sample/sample_env_file.list
2020
```
2121

22-
The `docker-prod.override.yml` contains the list of images to run the app. It comes with an nginx reverse proxy that by default will run on port 80. You will most likely want to change the port that nginx runs on as well as use a fix tag for the image. By default, all are set to latest.
22+
The `docker-prod.override.yml` specifies the port that OpenEats is served from as well as any override commands you have. The nginx reverse proxy will default to run on port 80. You will most likely want to change the port that nginx runs on. See [Creating a proxy serve for docker](Creating_a_proxy_server_for_docker.md) for more information on how to configure an nginx server to serve OpenEats.
2323

2424
#### Configure the environment file
2525
Most of the settings in your `env_prod.list` can stay the same as `env_stg.list` that is in this repo. There are a few config settings that need to be changed for most configurations. See [Setting_up_env_file.md](Setting_up_env_file.md) for a complete description of the environment variables.

docs/Running_the_App_in_dev.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ The recommended way to run this app is with docker. You can install docker [here
44

55
### Running the app with docker for development
66

7-
First you'll need to fork the appropriate repo that you are looking to make changes to.
7+
First you'll need to fork the appropriate repo that you are looking to make changes to, alone witht he core repo. See below for a sample.
88

99
```bash
1010
git clone https://github.com/open-eats/OpenEats.git
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)