Skip to content

Commit

Permalink
create-app: fix default backend listen config and comments
Browse files Browse the repository at this point in the history
Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
  • Loading branch information
Rugvip committed Nov 7, 2022
1 parent f121e3f commit 864c876
Show file tree
Hide file tree
Showing 3 changed files with 36 additions and 11 deletions.
31 changes: 31 additions & 0 deletions .changeset/witty-carrots-live.md
@@ -0,0 +1,31 @@
---
'@backstage/create-app': patch
---

Fixed incorrect comments in the templated `app-config.yaml` and `app-config.production.yaml`. The `backend.listen` directive is not in fact needed to override the `backend.baseUrl`, the backend listens to all interfaces by default. The configuration has also been updated to listen to all interfaces, rather than just IPv4 ones, as this is required for Node.js v18. The production configuration now also shows the option to specify `backend.listen` as a single string.

To apply this changes to an existing app, make the following change to `app-config.yaml`:

```diff
- # Uncomment the following host directive to bind to all IPv4 interfaces and
- # not just the baseUrl hostname.
- # host: 0.0.0.0
+ # Uncomment the following host directive to bind to specific interfaces
+ # host: 127.0.0.1
```

And the following change to `app-config.production.yaml`:

```diff
- listen:
- port: 7007
- # The following host directive binds to all IPv4 interfaces when its value
- # is "0.0.0.0". This is the most permissive setting. The right value depends
- # on your specific deployment. If you remove the host line entirely, the
- # backend will bind on the interface that corresponds to the backend.baseUrl
- # hostname.
- host: 0.0.0.0
+ # The listener can also be expressed as a single <host>:<port> string. In this case we bind to
+ # all interfaces, the most permissive setting. The right value depends on your specific deployment.
+ listen: ':7007'
```
Expand Up @@ -9,14 +9,9 @@ backend:
# callers. When its value is "http://localhost:7007", it's strictly private
# and can't be reached by others.
baseUrl: http://localhost:7007
listen:
port: 7007
# The following host directive binds to all IPv4 interfaces when its value
# is "0.0.0.0". This is the most permissive setting. The right value depends
# on your specific deployment. If you remove the host line entirely, the
# backend will bind on the interface that corresponds to the backend.baseUrl
# hostname.
host: 0.0.0.0
# The listener can also be expressed as a single <host>:<port> string. In this case we bind to
# all interfaces, the most permissive setting. The right value depends on your specific deployment.
listen: ':7007'

# config options: https://node-postgres.com/api/client
database:
Expand Down
5 changes: 2 additions & 3 deletions packages/create-app/templates/default-app/app-config.yaml.hbs
Expand Up @@ -15,9 +15,8 @@ backend:
baseUrl: http://localhost:7007
listen:
port: 7007
# Uncomment the following host directive to bind to all IPv4 interfaces and
# not just the baseUrl hostname.
# host: 0.0.0.0
# Uncomment the following host directive to bind to specific interfaces
# host: 127.0.0.1
csp:
connect-src: ["'self'", 'http:', 'https:']
# Content-Security-Policy directives follow the Helmet format: https://helmetjs.github.io/#reference
Expand Down

0 comments on commit 864c876

Please sign in to comment.