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.

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

Encryption variable missing in Quickstart guide #254

Closed
Tatamanilo opened this issue Feb 18, 2022 · 3 comments
Closed

Encryption variable missing in Quickstart guide #254

Tatamanilo opened this issue Feb 18, 2022 · 3 comments
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@Tatamanilo
Copy link

Subject of the issue

in the pull request #229 the Encryption mechanism is added for storing and retrieving API keys, but in documentation for quick start - this variable is missed in the list that user should specify. It can cause problems when developer building up the platform, specify the length of the secret key (32 symbols)

Steps to reproduce

Follow quickstart guide, run platform via docker-compose up

Expected behaviour

properly running container xes-platform

Actual behaviour

The PROXEUS_ENCRYPTION_SECRET_KEY variable is not set. Defaulting to a blank string.
Container xes-platform is not up
image
xes-platform | 2022/02/18 14:32:52 Unable to start Proxeus.

Solution

should be set as default value in docker-compose + updated doc for Quick start

add this valiable in the list of export:

Run the following command in the directory containing your docker-compose.yml file (Linux and OSX):
export PROXEUS_ENCRYPTION_SECRET_KEY?=PleAsE_chAnGe_me_32_Characters++
@loleg loleg added the documentation Improvements or additions to documentation label Apr 29, 2022
@loleg
Copy link
Contributor

loleg commented Feb 16, 2023

We need to clarify where developers update the docs.

@loleg loleg self-assigned this Feb 16, 2023
@tafonina
Copy link
Contributor

@loleg clarify pls the source of http://doc.proxeus.com/#/README

@loleg loleg changed the title Lack of PROXEUS_ENCRYPTION_SECRET_KEY variable in Quickstart guide Encryption variable missing in Quickstart guide Mar 2, 2023
@loleg
Copy link
Contributor

loleg commented Oct 16, 2023

This was fixed a while ago, thanks everyone.

@loleg loleg closed this as completed Oct 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

No branches or pull requests

3 participants