readme #2
Merged
readme #2
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
This commit removes redundant line gaps from the introductory paragraph and expands the "Parameters" section in README.md. The added information provides directions on using backend and frontend environment variables. This is crucial for users to configure the application to suit their needs and facilitate its usage.
Added new environment variables to the README.md to accommodate recently introduced features related to authentication and keycloak. This step is crucial for better user understanding and environment setup. The added variables are related to the login provider, nextauth url, secrets, and keycloak authentication details.
The README.md file was edited to clearly identify 'AUTH_KEYCLOAK_ID', 'AUTH_KEYCLOAK_SECRET', and 'AUTH_KEYCLOAK_ISSUER' as mandatory fields when 'NEXT_PUBLIC_DEFAULT_LOGIN_PROVIDER' is set to 'keycloak.' Previously, these requirements were not very clear, leading to potential configuration errors.
Added sections describing the Backend and Frontend Ports to README.md. The ports detail which Ports are being used by the API, Websocket server, and UI. This clarifies operation and facilitates better understanding of the system by new users or developers.
Two new badges were added to the README file: License and Release. These badges provide quick and easy access to important repository information, improving the user experience and clarity of the project status.
An expanded list of environment variables for both backend and frontend have been added to the README. This update aims at enhancing communication regarding both the backend's HTTP and asset transfer and the frontend's provider login information, providing comprehensive information to facilitate setup and integration.
Added a new section in the README.md on how to correctly set up a reverse proxy such as nginx. This update is necessary as nextauth payloads can be large when redirecting back from the oauth provider and without these settings, the users might encounter unexpected `5XX` errors.
Replaced the markdown syntax for including images with HTML to gain control over image size in README.md. Necessary for displaying the images in an appropriate dimension and improve readability of the document.
The size of the `npm-advanced-tab` image has been updated in the README.md file to increase visibility. The width has been changed from 200 pixels to 250 pixels for better readability and user experience.
The wording in the section about reverse proxy setup has been clarified. This change is to help users avoid misunderstandings when adding configuration to their proxy host. The term "headers" has been replaced to reflect accurately that it's not only headers that need to be added, preventing possible `5XX` errors.
A new section describing the use of Minio, a self-hosted storage solution was added to the README. This addition provides important information for users about generation of AWS keys, use of these keys, and underscores the need for adherence to security best practices.
The README file has been significantly updated to include a comprehensive setup for docker-compose in a production environment. This setup guide includes detailed configuration instructions for vital services such as PostgreSQL, Minio, and the openpro backend and frontend. The changes were made to better guide users through setting up a production-ready environment.
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.
No description provided.