Refactor docker installation and docs #764
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
prasadtalasila
commented
May 18, 2024
prasadtalasila
commented
- Refactors docker files into deploy and developer parts
- Simplifies the localhost installation for docker compose
- Remove the shell script installation scripts
- Removes the redundant traefik config files ins servers/config
- Updates some of the docs
![codeclimate[bot]](https://avatars.githubusercontent.com/in/9403?s=60&v=4){kind=small}
deploy/README.md
Outdated
| [reactjs](https://krify.co/about-reactjs/), | ||
| [nestjs](https://camunda.com/blog/2019/10/nestjs-tx-email/) | ||
| 1. Single user [localhost](./docker/LOCALHOST.md) | ||
| 2. Multi-user [web application](./docker/SERVER.md) |
| If you desire to use locally hosted gitlab instance, please see | ||
| the [client docs](../docs/admin/client/auth.md). | ||
|
|
||
|
|
There was a problem hiding this comment.
Multiple consecutive blank lines
deploy/docker/LOCALHOST.md
Outdated
| ## Use | ||
|
|
||
| The application will be accessible at: | ||
| <http>_http://localhost_</http> from web browser. |
deploy/docker/README.md
Outdated
| There are two installation scenarios each with a dedicated set of instructions: | ||
|
|
||
| 1. Single user [localhost](./LOCALHOST.md) | ||
| 2. Multi-user [web application](./SERVER.md) |
deploy/docker/SERVER.md
Outdated
| ## Use | ||
|
|
||
| The application will be accessible at: | ||
| <http>_http://foo.com_</http> from web browser. |
Codecov ReportAll modified and coverable lines are covered by tests ✅
❗ Your organization needs to install the Codecov GitHub app to enable full functionality. Additional details and impacted files@@ Coverage Diff @@
## feature/distributed-demo #764 +/- ##
=============================================================
+ Coverage 66.49% 91.66% +25.16%
=============================================================
Files 31 11 -20
Lines 394 84 -310
Branches 26 7 -19
=============================================================
- Hits 262 77 -185
+ Misses 117 0 -117
+ Partials 15 7 -8 see 34 files with indirect coverage changes
|
docs/admin/host.md
Outdated
|
|
||
| ## Perform the Installation | ||
| The application will be accessible at: | ||
| <http>_http://foo.com_</http> from web browser. |
docs/admin/localhost.md
Outdated
| ## Use | ||
|
|
||
| The application will be accessible at: | ||
| <http>_http://localhost_</http> from web browser. |
docker/README.md
Outdated
| The Traefik forward-auth uses OAuth2 for protecting all routes to user workspaces. | ||
| Use of docker images is handy for developers. It is suggested | ||
| that developers build the required images locally on their computer and | ||
| use them for development purposes. |
docker/README.md
Outdated
|
|
||
| ## Adding a new user | ||
| Build and publish the docker images. This step is required only for | ||
| the publication of images to Docker Hub. |
docker/README.md
Outdated
| 1. docker/.env | ||
| please see [docker README](../deploy/docker/SERVER.md) for help | ||
| with updating this config file) | ||
| 2. docker/conf.local |
|
|
||
| 1. The path examples given here are for Linux OS. |
docker/README.md
Outdated
| 2. docker/conf.local | ||
| please see [server docs](../docs/admin/servers/auth.md) for help | ||
| with updating this config file) | ||
| 3. client/config/local.js |
docker/README.md
Outdated
| 3. client/config/local.js | ||
| please see [client config](../docs/admin/client/CLIENT.md) for help | ||
| with updating this config file) | ||
| 4. servers/lib/config/.env.default |
docker/README.md
Outdated
|
|
||
| Sign in to gitlab instance with the your account. | ||
| The application will be accessible at: | ||
| <http>_http://localhost_</http> from web browser. |
prasadtalasila
force-pushed
the
simplify-docker-localhost-install
branch
from
8e50d31 to
55e37c1
Compare
|
|
||
| !!! tip file pathnames | ||
|
|
||
| 1. The filepaths shown here follow Linux OS. |
| for client. The corresponding OAuth application | ||
| details are: | ||
|
|
||
| ```js |
| <!-- prettier-ignore --> | ||
| !!! tip file pathnames | ||
|
|
||
| 1. The filepaths shown here follow POSIX convention. |
|
Code Climate has analyzed commit 5e26fbd and detected 4 issues on this pull request. Here's the issue category breakdown:
View more on Code Climate. |
prasadtalasila
merged commit 725e144
into
INTO-CPS-Association:feature/distributed-demo
4 checks passed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.