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

Jump to bottom

docs: running using docker modified #7216

Merged
merged 5 commits into from
Sep 11, 2020
Merged

docs: running using docker modified #7216

merged 5 commits into from
Sep 11, 2020

Conversation

DiptoChakrabarty
Copy link
Member

@DiptoChakrabarty DiptoChakrabarty commented Aug 17, 2020 •
edited
Loading

Fixes #7161

Short description of what this resolves:

This has the updated documentation on how to deploy the open event API Server using docker compose

Changes proposed in this pull request:

  • Port in which server will run updated
  • Command to create tables modified
  • Steps to create env file for production use

Checklist

  • I have read the Contribution & Best practices Guide and my PR follows them.
  • My branch is up-to-date with the Upstream development branch.
  • The unit tests pass locally with my changes
  • I have added tests that prove my fix is effective or that my feature works
  • I have added necessary documentation (if appropriate)
  • All the functions created/modified in this PR contain relevant docstrings.

@codecov
Copy link

codecov bot commented Aug 17, 2020 •
edited
Loading

Codecov Report

Merging #7216 into development will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff              @@
##           development    #7216   +/-   ##
============================================
  Coverage        62.98%   62.98%           
============================================
  Files              259      259           
  Lines            13042    13042           
============================================
  Hits              8214     8214           
  Misses            4828     4828

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update c6b6d20...fdc25d0. Read the comment docs.

@iamareebjamal
Copy link
Member

Steps are still incorrect. Many of the commands are obsolete

@DiptoChakrabarty
Copy link
Member Author

Steps are still incorrect. Many of the commands are obsolete

Hey just tried again and modified the steps once again

iamareebjamal
iamareebjamal reviewed Aug 17, 2020
View reviewed changes
docs/installation/docker.md Outdated
```bash
export SERVER_NAME=localhost;
```

* craete env file using the following command
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* craete env file using the following command
* create env file using the following command

iamareebjamal
iamareebjamal reviewed Aug 17, 2020
View reviewed changes
docs/installation/docker.md
@@ -28,30 +21,10 @@ export SERVER_NAME=localhost;
Add SECRET_KEY in the env file to run properly in production mode . To generate a good secret value run python -c 'import secrets;print(secrets.token_hex())'



* In the same terminal window, run `docker-compose build` to build open-event-server's docker image. This process can take some time.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed

iamareebjamal
iamareebjamal reviewed Aug 17, 2020
View reviewed changes
docs/installation/docker.md Outdated
@@ -28,30 +21,10 @@ export SERVER_NAME=localhost;
Add SECRET_KEY in the env file to run properly in production mode . To generate a good secret value run python -c 'import secrets;print(secrets.token_hex())'



* In the same terminal window, run `docker-compose build` to build open-event-server's docker image. This process can take some time.

* After build is done, run `docker-compose up` to start the server.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* After build is done, run `docker-compose up` to start the server.
* After build is done, run `docker-compose up -d` to start the server.

iamareebjamal
iamareebjamal reviewed Aug 18, 2020
View reviewed changes
docs/installation/docker.md Outdated

```sh
cp .env.example .env
```
Add SECRET_KEY in the env file to run properly in production mode . To generate a good secret value run python -c 'import secrets;print(secrets.token_hex())'
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was needed

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

My apologies added them again , should I remove build image step because docker-compose up -d automatically builds the images and starts the server

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do I need to do change anything further

@iamareebjamal iamareebjamal changed the title doc for running using docker modified docs: running using docker modified Sep 11, 2020
@auto-label auto-label bot added the docs label Sep 11, 2020
@iamareebjamal iamareebjamal merged commit c3912fd into fossasia:development Sep 11, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@iamareebjamal iamareebjamal iamareebjamal approved these changes

Assignees
No one assigned
Labels
docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Create recommended installation steps for docker-compose and link in frontend
2 participants
@DiptoChakrabarty @iamareebjamal