forked from backstage/backstage
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
document how to override the default port
Port 3000 is a common port in the development environment. This documents how you can start backstage with a different port to the default. Moved section for development environment to own page within docs in order to keep README small.
- Loading branch information
Showing
3 changed files
with
38 additions
and
10 deletions.
There are no files selected for viewing
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 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 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
# Development Environment | ||
|
||
Open a terminal window and start the web app using the following commands from the project root: | ||
|
||
```bash | ||
$ yarn install # may take a while | ||
|
||
$ yarn start | ||
``` | ||
|
||
The final `yarn start` command should open a local instance of Backstage in your browser, otherwise open one of the URLs printed in the terminal. | ||
|
||
By default, backstage will start on port 3000, however you can override this by setting an environment variable `PORT` on your local machine. e.g. `export PORT=8080` then running `yarn start`. Or `PORT=8080 yarn start`. | ||
|
||
Once successfully started, you should see the following message in your terminal window: | ||
|
||
``` | ||
You can now view @backstage/app in the browser. | ||
Local: http://localhost:8080 | ||
On Your Network: http://192.168.1.224:8080 | ||
``` | ||
|
||
### (Optional)Try on Docker | ||
|
||
Run the following commands if you have Docker environment | ||
|
||
```bash | ||
$ docker build . -t spotify/backstage | ||
$ docker run --rm -it -p 80:80 spotify/backstage | ||
``` | ||
|
||
Then open http://localhost/ on your browser. | ||
|
||
[Back to Docs](README.md) |