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

Add SBCONFIG_PORT to documentation #662

Closed
pierrecholhot opened this issue Jan 5, 2017 · 1 comment
Closed

Add SBCONFIG_PORT to documentation #662

pierrecholhot opened this issue Jan 5, 2017 · 1 comment

Comments

@pierrecholhot
Copy link

According to the docs, the following is the default method to run the storybook:

start-storybook -p 5700

However, I stumbled upon this undocumented SBCONFIG_PORT environment variable in the code while looking for a way to run the storybook remotely on a specific port defined as an ENV_VAR.

It turns out I can start the server this way, without specifying the port with -p:

export SBCONFIG_PORT=5700
start-storybook

Is it recommended to use SBCONFIG_PORT ? If so, it could be useful to find a mention of this in the docs.


As a side note, I edited my init script to use this environment variable only if it's set, otherwise, fallback to the default hardcoded. The reason is to be able to set a different PORT on a remote env without having to EXPORT one locally.

start-storybook -p ${SBCONFIG_PORT:-5700}
@arunoda
Copy link
Member

arunoda commented Jan 5, 2017

SBCONFIG_PORT is something we did for some internal tooling.
It's never meant for public use.
We may remove it in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants