Replace HOST with BIND, which is the more appropriate name for this option

Author: ThisIsMissEm

.env.sample

@@ -1,17 +1,23 @@
 DATABASE_URL=postgresql://user:password@localhost:5432/dbname
 SENTRY_DSN=
-HOME_URL=https://example.com/  # optional; if present, the home page will redirect to this URL
 SECRET_KEY=secret_key  # generate a secret key with `openssl rand -base64 32`
+HOME_URL=https://example.com/  # optional; if present, the home page will redirect to this URL
+
 LOG_LEVEL=info
 LOG_QUERY=false
+
 BEHIND_PROXY=false
-LISTEN_PORT=3000
+PORT=3000
+# BIND=localhost
+
 # Setting ALLOW_PRIVATE_ADDRESS to true disables SSRF (Server-Side Request Forgery) protection
 # Set to true to test in local network
 # Will be replaced by list of allowed IPs once https://github.com/dahlia/fedify/issues/157
 # is implemented.
 ALLOW_PRIVATE_ADDRESS=false
+
 REMOTE_ACTOR_FETCH_POSTS=10
+
 DRIVE_DISK=
 ASSET_URL_BASE=
 FS_ASSET_PATH=

CHANGES.md

@@ -6,7 +6,7 @@ Version 0.6.0
 
 To be released.
 
- -  Added the `HOST` environment variable to specify the host address to
+ -  Added the `BIND` environment variable to specify the host address to
     listen on.  [[#114] by Emelia Smith]
 
  -  The theme color of the profile page is now customizable.  The list of all

bin/server.ts

@@ -12,18 +12,20 @@ configureSentry(process.env["SENTRY_DSN"]);
 const BEHIND_PROXY = process.env["BEHIND_PROXY"] === "true";
 
 // biome-ignore lint/complexity/useLiteralKeys: tsc complains about this (TS4111)
-const LISTEN_HOST = process.env["HOST"];
+const BIND = process.env["BIND"];
 
 // biome-ignore lint/complexity/useLiteralKeys: tsc complains about this (TS4111)
-const LISTEN_PORT = Number.parseInt(process.env["PORT"] ?? "3000", 10);
+const PORT = Number.parseInt(process.env["PORT"] ?? "3000", 10);
 
-if (!Number.isInteger(LISTEN_PORT)) {
+if (!Number.isInteger(PORT)) {
   console.error("Invalid PORT: must be an integer");
   process.exit(1);
 }
 
-if (LISTEN_HOST && LISTEN_HOST !== "localhost" && !isIP(LISTEN_HOST)) {
-  console.error("Invalid HOST: must be an IP address, if specified");
+if (BIND && BIND !== "localhost" && !isIP(BIND)) {
+  console.error(
+    "Invalid BIND: must be an IP address or localhost, if specified",
+  );
   process.exit(1);
 }
 
@@ -32,12 +34,13 @@ serve(
     fetch: BEHIND_PROXY
       ? behindProxy(app.fetch.bind(app))
       : app.fetch.bind(app),
-    port: LISTEN_PORT,
-    hostname: LISTEN_HOST ?? "localhost",
+    port: PORT,
+    hostname: BIND,
   },
   (info) => {
     let host = info.address;
-    if (LISTEN_HOST === "localhost") {
+    // We override it here to show localhost instead of what it resolves to:
+    if (BIND === "localhost") {
       host = "localhost";
     } else if (info.family === "IPv6") {
       host = `[${info.address}]`;

docs/src/content/docs/install/env.mdx

@@ -3,25 +3,21 @@ title: Environment variables
 description: How to configure Hollo using environment variables.
 ---
 
-import { Aside, Badge } from '@astrojs/starlight/components';
+import { Aside, Badge } from "@astrojs/starlight/components";
 
-Hollo is configured using environment variables.  You can set them in an *.env*
+Hollo is configured using environment variables. You can set them in an _.env_
 file in the root directory of the project, or you can set them using Docker's
 `-e`/`--env` option or Railway's environment variables.
 
-
-Basic settings
---------------
+## Basic settings
 
 ### `PORT` <Badge text="Optional" /> <Badge text="Unused in Railway" variant="tip" />
 
-The port number to listen on.  3000 by default.
-
-### `HOST` <Badge text="Optional" /> <Badge text="Unused in Railway" variant="tip" />
+The port number to listen on. 3000 by default.
 
-The host address to listen on.  Must be a valid IP address or `localhost`.
+### `BIND` <Badge text="Optional" /> <Badge text="Unused in Railway" variant="tip" />
 
-`localhost` by default.
+The address to listen on. Must be a valid IP address or `localhost`.
 
 ### `DATABASE_URL` <Badge text="Unused in Railway" variant="tip" />
 
@@ -30,30 +26,30 @@ The URL of the PostgreSQL database, e.g.,
 
 ### `SECRET_KEY` <Badge text="Unused in Railway" variant="tip" />
 
-The secret key for securing the session.  You can generate a random secret key
+The secret key for securing the session. You can generate a random secret key
 using the following command:
 
-~~~~ sh frame="none"
+```sh frame="none"
 openssl rand -hex 32
-~~~~
+```
 
 ### `TZ` <Badge text="Optional" />
 
-The time zone of the application.  It has to be a valid time zone identifier,
+The time zone of the application. It has to be a valid time zone identifier,
 e.g., `UTC`, `America/New_York`, `Asia/Tokyo`.
 
 `UTC` by default.
 
 ### `BEHIND_PROXY` <Badge text="Optional" /> <Badge text="Unused in Railway" variant="tip" />
 
-Set this to `true` if Hollo is behind a reverse proxy.  If you place the Hollo
+Set this to `true` if Hollo is behind a reverse proxy. If you place the Hollo
 behind an L7 load balancer (you usually should do this), turn this on.
 
 Turned off by default.
 
 <Aside>
   With this option, Hollo will trust the `X-Forwarded-For`, `X-Forwarded-Proto`,
-  and `X-Forwarded-Host` headers from the reverse proxy.  This is important for
+  and `X-Forwarded-Host` headers from the reverse proxy. This is important for
   security reasons.
 </Aside>
 
@@ -66,17 +62,15 @@ Turn on to test in local network.
 Turned off by default.
 
 <Aside>
-  Turning on this option is dangerous security-wise.  Only use this option in
-  a trusted environment and never in production.
+  Turning on this option is dangerous security-wise. Only use this option in a
+  trusted environment and never in production.
 </Aside>
 
+## Additional features
 
-Additional features
--------------------
+### `HOME_URL` <Badge text="Optional" />
 
-###  `HOME_URL` <Badge text="Optional" />
-
-If present, the home page will redirect to this URL.  If not set, the home page
+If present, the home page will redirect to this URL. If not set, the home page
 will show the list of accounts on the instance.
 
 ### `REMOTE_ACTOR_FETCH_POSTS` <Badge text="Optional" />
@@ -90,7 +84,7 @@ encountered first time.
 
 Setting this to `true` lets your timelines work like inboxes: all posts visible
 to your timeline are physically stored in the database, rather than being
-filtered in real-time as they are displayed.  This is useful for relatively
+filtered in real-time as they are displayed. This is useful for relatively
 larger instances with many incoming posts.
 
 As of Hollo 0.4.0, it is experimental and may have several bugs, but it is
@@ -101,19 +95,17 @@ Turned off by default.
 ### `ALLOW_HTML` <Badge text="Optional" />
 
 Setting this to `true` allows raw HTML inside Markdown, which is used for
-formatting posts, bio, etc.  This is useful for allowing users to use broader
+formatting posts, bio, etc. This is useful for allowing users to use broader
 formatting options outside of Markdown, but to avoid XSS attacks, it is still
 limited to a subset of HTML tags and attributes.
 
 Turned off by default.
 
-
-Logging and debugging
----------------------
+## Logging and debugging
 
 ### `LOG_LEVEL` <Badge text="Optional" />
 
-The log level for the application.  `debug`, `info`, `warning`, `error`, and
+The log level for the application. `debug`, `info`, `warning`, `error`, and
 `fatal` are available.
 
 `info` by default.
@@ -126,16 +118,14 @@ Turned off by default.
 
 ### `LOG_FILE` <Badge text="Optional" />
 
-The path to the log file.  Unlike console output, the log file is written in
+The path to the log file. Unlike console output, the log file is written in
 JSON Lines format which is suitable for structured logging.
 
 ### `SENTRY_DSN` <Badge text="Optional" />
 
 The DSN of the Sentry project to send error reports and traces to.
 
-
-Asset storage
--------------
+## Asset storage
 
 ### `DRIVE_DISK`
 
@@ -154,9 +144,10 @@ See the [FlyDrive docs] for details about the drivers.
   production, existing files are not moved; only new files are stored according
   to the new settings.
 
-  Also, keep in mind that existing files will still be served according to the
-  old settings, so if you change `S3_BUCKET`, for example, they will still be
-  served from the old bucket and should not be deleted.
+Also, keep in mind that existing files will still be served according to the
+old settings, so if you change `S3_BUCKET`, for example, they will still be
+served from the old bucket and should not be deleted.
+
 </Aside>
 
 [FlyDrive docs]: https://flydrive.dev/docs/drive_manager
@@ -169,39 +160,38 @@ The path in the local filesystem where blob assets are stored, e.g.,
 `/var/lib/hollo`.
 
 <Aside>
-  - Directory must exist and be writable by the Hollo process.
-  - Recommended permissions: 755 for directories, 644 for files.
-  - Ensure sufficient storage capacity for your use case.
-  - Regular backups are strongly recommended.
-  - When using Docker, ensure the path is properly mounted.
+  - Directory must exist and be writable by the Hollo process. - Recommended
+  permissions: 755 for directories, 644 for files. - Ensure sufficient storage
+  capacity for your use case. - Regular backups are strongly recommended. - When
+  using Docker, ensure the path is properly mounted.
 </Aside>
 
 ### S3-compatible object storage settings
 
 <Aside>
   These settings are only required when `DRIVE_DISK=s3`.
 
-  Ensure your AWS IAM policy grants the following permissions:
+Ensure your AWS IAM policy grants the following permissions:
 
-  - `s3:PutObject`
-  - `s3:GetObject`
-  - `s3:DeleteObject`
-  - `s3:ListBucket`
-</Aside>
+- `s3:PutObject`
+- `s3:GetObject`
+- `s3:DeleteObject`
+- `s3:ListBucket`
+  </Aside>
 
 #### `ASSET_URL_BASE` <Badge text="Required with S3 driver" variant="caution" />
 
 The public URL base of the asset storage, e.g.,
 `https://hollo.s3.us-east-1.amazonaws.com`.
 
 <Aside type="caution">
-  - HTTPS is required in production environments.
-  - Must be publicly accessible for federation to work correctly.
+  - HTTPS is required in production environments. - Must be publicly accessible
+  for federation to work correctly.
 </Aside>
 
 #### `S3_REGION` <Badge text="Required with S3 driver" variant="caution" />
 
-The region of the S3-compatible object storage, e.g., `us-east-1`.  On some
+The region of the S3-compatible object storage, e.g., `us-east-1`. On some
 non-S3 services, this can be omitted.
 
 #### `S3_BUCKET` <Badge text="Required with S3 driver" variant="caution" />
@@ -215,8 +205,8 @@ The endpoint URL for S3-compatible object storage, e.g.,
 
 #### `S3_FORCE_PATH_STYLE` <Badge text="Optional" />
 
-Whether to force path-style URLs for S3-compatible object storage.  `true` to
-turn on, `false` to turn off.  Useful for non-AWS S3-compatible services.
+Whether to force path-style URLs for S3-compatible object storage. `true` to
+turn on, `false` to turn off. Useful for non-AWS S3-compatible services.
 Turned off by default.
 
 #### `AWS_ACCESS_KEY_ID` <Badge text="Required with S3 driver" variant="caution" />

docs/src/content/docs/ja/install/env.mdx

@@ -18,12 +18,10 @@ Railwayのenvironment variablesメニューから設定できます。
 
 サーバーが受信するポート番号。デフォルトは3000です。
 
-### `HOST` <Badge text="オプション" /> <Badge text="Railwayでは使われない" variant="tip" />
+### `BIND` <Badge text="オプション" /> <Badge text="Railwayでは使われない" variant="tip" />
 
 サーバーが受信するホストアドレス。有効なIPアドレスまたは`localhost`である必要があります。
 
-デフォルトは`localhost`です。
-
 ### `DATABASE_URL` <Badge text="Railwayでは使われない" variant="tip" />
 
 PostgreSQLのデータベースのURL。例：`postgresql://hollo:password@localhost/hollo`

docs/src/content/docs/ko/install/env.mdx

@@ -18,12 +18,10 @@ Railway의 environment variables 메뉴에서 설정할 수 있습니다.
 
 서버가 수신할 포트 번호. 기본값은 3000입니다.
 
-### `HOST` <Badge text="선택" /> <Badge text="Railway에서는 안 쓰임" variant="tip" />
+### `BIND` <Badge text="선택" /> <Badge text="Railway에서는 안 쓰임" variant="tip" />
 
 서버가 수신할 호스트 주소. 유효한 IP 주소나 `localhost`여야 합니다.
 
-기본값은 `localhost`입니다.
-
 ### `DATABASE_URL` <Badge text="Railway에서는 안 쓰임" variant="tip" />
 
 PostgreSQL 데이터베이스의 URL. 예: `postgresql://hollo:password@localhost/hollo`.

docs/src/content/docs/zh-cn/install/env.mdx

@@ -15,12 +15,10 @@ Hollo是通过环境变量进行配置的。你可以在项目根目录的 *.env
 
 服务器监听的端口号。默认为3000。
 
-### `HOST` <Badge text="可选" /> <Badge text="Railway中未使用" variant="tip" />
+### `BIND` <Badge text="可选" /> <Badge text="Railway中未使用" variant="tip" />
 
 服务器监听的主机地址。必须是有效的IP地址或`localhost`。
 
-默认是`localhost`。
-
 ### `DATABASE_URL` <Badge text="Railway中未使用" variant="tip" />
 
 PostgreSQL数据库的URL，例如：`postgresql://hollo:password@localhost/hollo`。