headscale/CHANGELOG.md

# CHANGELOG

**TBD (TBD):**

**BREAKING**:

- ACLs have been rewritten and the behavior is different from before. It's now more aligned to tailscale's view of the feature. Namespaces are viewed as users and can communicate with each others. Tags should now work correctly and adding a host to Headscale should now reload the rules. The documentation have a [fictional example](docs/acls.md) that should cover some use cases of the ACLs features.

**0.13.0 (2022-xx-xx):**

**Features**:

- Add IPv6 support to the prefix assigned to namespaces
- Add API Key support
  - Enable remote control of `headscale` via CLI [docs](docs/remote-cli.md)
  - Enable HTTP API (beta, subject to change)

**Changes**:

- `ip_prefix` is now superseded by `ip_prefixes` in the configuration [#208](https://github.com/juanfont/headscale/pull/208)
- Upgrade `tailscale` (1.20.4) and other dependencies to latest [#314](https://github.com/juanfont/headscale/pull/314)
- fix swapped machine<->namespace labels in `/metrics` [#312](https://github.com/juanfont/headscale/pull/312)
- remove key-value based update mechanism for namespace changes [#316](https://github.com/juanfont/headscale/pull/316)

**0.12.4 (2022-01-29):**

**Changes**:

- Make gRPC Unix Socket permissions configurable [#292](https://github.com/juanfont/headscale/pull/292)
- Trim whitespace before reading Private Key from file [#289](https://github.com/juanfont/headscale/pull/289)
- Add new command to generate a private key for `headscale` [#290](https://github.com/juanfont/headscale/pull/290)
- Fixed issue where hosts deleted from control server may be written back to the database, as long as they are connected to the control server [#278](https://github.com/juanfont/headscale/pull/278)

**0.12.3 (2022-01-13):**

**Changes**:

- Added Alpine container [#270](https://github.com/juanfont/headscale/pull/270)
- Minor updates in dependencies [#271](https://github.com/juanfont/headscale/pull/271)

**0.12.2 (2022-01-11):**

Happy New Year!

**Changes**:

- Fix Docker release [#258](https://github.com/juanfont/headscale/pull/258)
- Rewrite main docs [#262](https://github.com/juanfont/headscale/pull/262)
- Improve Docker docs [#263](https://github.com/juanfont/headscale/pull/263)

**0.12.1 (2021-12-24):**

(We are skipping 0.12.0 to correct a mishap done weeks ago with the version tagging)

**BREAKING**:

- Upgrade to Tailscale 1.18 [#229](https://github.com/juanfont/headscale/pull/229)
  - This change requires a new format for private key, private keys are now generated automatically:
    1. Delete your current key
    2. Restart `headscale`, a new key will be generated.
    3. Restart all Tailscale clients to fetch the new key

**Changes**:

- Unify configuration example [#197](https://github.com/juanfont/headscale/pull/197)
- Add stricter linting and formatting [#223](https://github.com/juanfont/headscale/pull/223)

**Features**:

- Add gRPC and HTTP API (HTTP API is currently disabled) [#204](https://github.com/juanfont/headscale/pull/204)
- Use gRPC between the CLI and the server [#206](https://github.com/juanfont/headscale/pull/206), [#212](https://github.com/juanfont/headscale/pull/212)
- Beta OpenID Connect support [#126](https://github.com/juanfont/headscale/pull/126), [#227](https://github.com/juanfont/headscale/pull/227)

**0.11.0 (2021-10-25):**

**BREAKING**:

- Make headscale fetch DERP map from URL and file [#196](https://github.com/juanfont/headscale/pull/196)
-												Add initial CHANGELOG

											
										
										
											2021-11-29 17:31:19 +00:00
+								# CHANGELOG
-												Leave the TDB

											
										
										
											2021-12-24 15:46:04 +00:00
+								**TBD (TBD):**
-												docs(changelog): bump changelog

											
										
										
											2022-02-14 13:02:18 +00:00
+								**BREAKING**:
-												chore(fmt): apply make fmt command

											
										
										
											2022-02-14 14:54:51 +00:00
+								- ACLs have been rewritten and the behavior is different from before. It's now more aligned to tailscale's view of the feature. Namespaces are viewed as users and can communicate with each others. Tags should now work correctly and adding a host to Headscale should now reload the rules. The documentation have a [fictional example](docs/acls.md) that should cover some use cases of the ACLs features.
-												docs(changelog): bump changelog

											
										
										
											2022-02-14 13:02:18 +00:00
-												Merge branch 'main' into ipv6
											
										
										
											2022-01-30 08:21:11 +00:00
+								**0.13.0 (2022-xx-xx):**
 								**Features**:
-												Format changelog

											
										
										
											2022-01-30 08:25:49 +00:00
-												Merge branch 'main' into ipv6
											
										
										
											2022-01-30 08:21:11 +00:00
+								- Add IPv6 support to the prefix assigned to namespaces
-												Update changelog

											
										
										
											2022-01-25 22:11:15 +00:00
+								- Add API Key support
 								  - Enable remote control of `headscale` via CLI [docs](docs/remote-cli.md)
 								  - Enable HTTP API (beta, subject to change)
-												Merge branch 'main' into ipv6
											
										
										
											2022-01-30 08:21:11 +00:00
-												Update CHANGELOG.md
											
										
										
											2022-01-29 14:31:42 +00:00
+								**Changes**:
-												CHANGELOG: document breaking configuration change regarding multiple prefixes

											
										
										
											2022-01-29 14:33:54 +00:00
-												Format changelog

											
										
										
											2022-01-30 08:25:49 +00:00
+								- `ip_prefix` is now superseded by `ip_prefixes` in the configuration [#208](https://github.com/juanfont/headscale/pull/208)
-												Update changelog

											
										
										
											2022-02-11 08:45:02 +00:00
+								- Upgrade `tailscale` (1.20.4) and other dependencies to latest [#314](https://github.com/juanfont/headscale/pull/314)
-												Merge branch 'main' into patch-1
											
										
										
											2022-02-11 10:56:46 +00:00
+								- fix swapped machine<->namespace labels in `/metrics` [#312](https://github.com/juanfont/headscale/pull/312)
-												Update changelog

											
										
										
											2022-02-12 20:50:17 +00:00
+								- remove key-value based update mechanism for namespace changes [#316](https://github.com/juanfont/headscale/pull/316)
-												Update CHANGELOG.md
											
										
										
											2022-01-29 14:31:42 +00:00
-												Tag 0.12.4 in CHANGELOG

											
										
										
											2022-01-29 20:04:56 +00:00
+								**0.12.4 (2022-01-29):**
 								**Changes**:
-												Update CHANGELOG.md
											
										
										
											2022-01-29 14:31:42 +00:00
+								- Make gRPC Unix Socket permissions configurable [#292](https://github.com/juanfont/headscale/pull/292)
 								- Trim whitespace before reading Private Key from file [#289](https://github.com/juanfont/headscale/pull/289)
-												Update CHANGELOG.md
											
										
										
											2022-01-29 14:33:12 +00:00
+								- Add new command to generate a private key for `headscale` [#290](https://github.com/juanfont/headscale/pull/290)
-												fixup! update CHANGELOG

											
										
										
											2022-01-28 21:00:13 +00:00
+								- Fixed issue where hosts deleted from control server may be written back to the database, as long as they are connected to the control server [#278](https://github.com/juanfont/headscale/pull/278)
-												Update CHANGELOG.md
											
										
										
											2022-01-29 14:31:42 +00:00
-												Updated changelog for 0.12.3

											
										
										
											2022-01-13 11:42:56 +00:00
+								**0.12.3 (2022-01-13):**
 								**Changes**:
 								- Added Alpine container [#270](https://github.com/juanfont/headscale/pull/270)
 								- Minor updates in dependencies [#271](https://github.com/juanfont/headscale/pull/271)
-												Updated changelog for 0.12.2

											
										
										
											2022-01-11 14:45:13 +00:00
+								**0.12.2 (2022-01-11):**
 								Happy New Year!
 								**Changes**:
 								- Fix Docker release [#258](https://github.com/juanfont/headscale/pull/258)
 								- Rewrite main docs [#262](https://github.com/juanfont/headscale/pull/262)
 								- Improve Docker docs [#263](https://github.com/juanfont/headscale/pull/263)
-												Update changelog for 0.12.1

											
										
										
											2021-12-24 15:39:22 +00:00
+								**0.12.1 (2021-12-24):**
 								(We are skipping 0.12.0 to correct a mishap done weeks ago with the version tagging)
-												Add initial CHANGELOG

											
										
										
											2021-11-29 17:31:19 +00:00
 								**BREAKING**:
-												format

											
										
										
											2021-11-29 17:34:41 +00:00
+								- Upgrade to Tailscale 1.18 [#229](https://github.com/juanfont/headscale/pull/229)
 								  - This change requires a new format for private key, private keys are now generated automatically:
 . Delete your current key
 . Restart `headscale`, a new key will be generated.
 . Restart all Tailscale clients to fetch the new key
-												Add initial CHANGELOG

											
										
										
											2021-11-29 17:31:19 +00:00
 								**Changes**:
-												format

											
										
										
											2021-11-29 17:34:41 +00:00
-												Clarify and formatting
											
										
										
											2021-11-30 09:17:21 +00:00
+								- Unify configuration example [#197](https://github.com/juanfont/headscale/pull/197)
-												Add initial CHANGELOG

											
										
										
											2021-11-29 17:31:19 +00:00
+								- Add stricter linting and formatting [#223](https://github.com/juanfont/headscale/pull/223)
-												Change changelog format

											
										
										
											2021-11-29 19:45:31 +00:00
-												Add Open ID connect to changelog
											
										
										
											2021-11-30 09:16:09 +00:00
+								**Features**:
-												Clarify and formatting
											
										
										
											2021-11-30 09:17:21 +00:00
+								- Add gRPC and HTTP API (HTTP API is currently disabled) [#204](https://github.com/juanfont/headscale/pull/204)
 								- Use gRPC between the CLI and the server [#206](https://github.com/juanfont/headscale/pull/206), [#212](https://github.com/juanfont/headscale/pull/212)
 								- Beta OpenID Connect support [#126](https://github.com/juanfont/headscale/pull/126), [#227](https://github.com/juanfont/headscale/pull/227)
-												Add Open ID connect to changelog
											
										
										
											2021-11-30 09:16:09 +00:00
-												Change changelog format

											
										
										
											2021-11-29 19:45:31 +00:00
+								**0.11.0 (2021-10-25):**
 								**BREAKING**:
 								- Make headscale fetch DERP map from URL and file [#196](https://github.com/juanfont/headscale/pull/196)