Release 0.6.2 (#115)

* Release 0.6.2 * Version docs
fishjam-dev · May 22, 2024 · d8b279e · d8b279e
1 parent 231414a
commit d8b279e
Show file tree

Hide file tree

Showing 44 changed files with 36 additions and 20 deletions.
diff --git a/docs/deploying/vps.md b/docs/deploying/vps.md
@@ -87,7 +87,7 @@ We prepared a template *cloud-config* that will configure your server and start
       owner: fishjam:fishjam
 
   runcmd:
-    - export FISHJAM_VERSION=0.5.0
+    - export FISHJAM_VERSION=0.6.2
     - export FISHJAM_DOMAIN=mydomain.example.com
     - export LETSENCRYPT_EMAIL=my@email.com
     - export SERVER_API_TOKEN=test_token

diff --git a/docs/getting_started/components/rtsp.md b/docs/getting_started/components/rtsp.md
@@ -69,7 +69,7 @@ docker run -p 20000:20000/udp \
            -p 8080:8080/tcp \
            -e FJ_SERVER_API_TOKEN=token \
            -e FJ_HOST=localhost:8080 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 :::caution
@@ -87,5 +87,5 @@ Using host network (Linux only)
 docker run --network=host \
            -e FJ_SERVER_API_TOKEN=token \
            -e FJ_HOST=localhost:8080 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
diff --git a/docs/getting_started/installation.md b/docs/getting_started/installation.md
@@ -83,7 +83,7 @@ need to set a couple of [environment variables](#environment-variables).
 An example docker command running bare Fishjam HTTP service locally:
 
 ```bash
-docker run -p 8080:8080/tcp -e FJ_HOST=localhost:8080 -e FJ_SERVER_API_TOKEN=token ghcr.io/fishjam-dev/fishjam:0.5.0
+docker run -p 8080:8080/tcp -e FJ_HOST=localhost:8080 -e FJ_SERVER_API_TOKEN=token ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 Note that in real case scenarios, docker commands depend on peers/components you are going to use.

diff --git a/docs/getting_started/peers/webrtc.md b/docs/getting_started/peers/webrtc.md
@@ -50,7 +50,7 @@ docker run -p 50000-50050:50000-50050/udp \
            -e FJ_WEBRTC_TURN_PORT_RANGE=50000-50050 \
            -e FJ_WEBRTC_TURN_IP=192.168.0.1 \
            -e FJ_WEBRTC_TURN_LISTEN_IP=0.0.0.0 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 :::caution
@@ -69,5 +69,5 @@ docker run --network=host \
            -e FJ_WEBRTC_USED=true \
            -e FJ_WEBRTC_TURN_IP=192.168.0.1 \
            -e FJ_WEBRTC_TURN_LISTEN_IP=0.0.0.0 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
diff --git a/docs/release_notes.md b/docs/release_notes.md
@@ -1,13 +1,19 @@
 # Release Notes
 
+## 0.6.2 - 22.05.2024
+
+### Features
+* Log level may now be configured using the `FJ_LOG_LEVEL` env variable
+* Room IDs may now contain underscores as well as alphanumeric characters and hyphens
+
 ## 0.6.1 - 17.05.2024
 
 ### Bugfixes
 * Fallback to `JF_*` env vars when `FJ_*` ones are missing in all cases.
 
 ## 0.6.0 - 16.05.2024
 
-### Features:
+### Features
 * Rebranding: Jellyfish -> Fishjam. All env vars have been renamed from `JF_*` to `FJ_*`.
 When a new env var is not set, an old one is tried.
 This behaviour will be removed in version 0.8.0. **[BREAKING]**
@@ -103,4 +109,4 @@ clearing or updating env vars when running from source on macOS. See [here](./ge
 * tests fixes and stability improvements
 * fixed URL to Jellydashboard
 * **prevent from unauthorized access to system files via REST API**
-* fixed Prometheus metrics resolution - Prometheus metrics are now updated as soon as an event occurs instead of every X seconds
+* fixed Prometheus metrics resolution - Prometheus metrics are now updated as soon as an event occurs instead of every X seconds
diff --git a/docs/tutorials/common/_starting-fishjam-media-server.mdx b/docs/tutorials/common/_starting-fishjam-media-server.mdx
@@ -11,7 +11,7 @@ docker run -p 50000-50050:50000-50050/udp \
            -e FJ_WEBRTC_TURN_IP=<your ip address> \
            -e FJ_WEBRTC_TURN_LISTEN_IP=0.0.0.0 \
            -e FJ_SERVER_API_TOKEN=development \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 Make sure to set `FJ_WEBRTC_TURN_IP` and `FJ_HOST` to your local IP address. Without it, the mobile device won't be able to connect to the Fishjam.

diff --git a/versioned_docs/version-0.6.1/benchmarks.md → versioned_docs/version-0.6.2/benchmarks.md b/versioned_docs/version-0.6.1/benchmarks.md → versioned_docs/version-0.6.2/benchmarks.md
diff --git a/...oned_docs/version-0.6.1/benchmarks/hls.md → ...oned_docs/version-0.6.2/benchmarks/hls.md b/...oned_docs/version-0.6.1/benchmarks/hls.md → ...oned_docs/version-0.6.2/benchmarks/hls.md
diff --git a/...d_docs/version-0.6.1/benchmarks/webrtc.md → ...d_docs/version-0.6.2/benchmarks/webrtc.md b/...d_docs/version-0.6.1/benchmarks/webrtc.md → ...d_docs/version-0.6.2/benchmarks/webrtc.md
diff --git a/versioned_docs/version-0.6.1/cluster.md → versioned_docs/version-0.6.2/cluster.md b/versioned_docs/version-0.6.1/cluster.md → versioned_docs/version-0.6.2/cluster.md
diff --git a/...ed_docs/version-0.6.1/deploying/fly_io.md → ...ed_docs/version-0.6.2/deploying/fly_io.md b/...ed_docs/version-0.6.1/deploying/fly_io.md → ...ed_docs/version-0.6.2/deploying/fly_io.md
diff --git a/...ioned_docs/version-0.6.1/deploying/vps.md → ...ioned_docs/version-0.6.2/deploying/vps.md b/...ioned_docs/version-0.6.1/deploying/vps.md → ...ioned_docs/version-0.6.2/deploying/vps.md
@@ -87,7 +87,7 @@ We prepared a template *cloud-config* that will configure your server and start
       owner: fishjam:fishjam
 
   runcmd:
-    - export FISHJAM_VERSION=0.5.0
+    - export FISHJAM_VERSION=0.6.2
     - export FISHJAM_DOMAIN=mydomain.example.com
     - export LETSENCRYPT_EMAIL=my@email.com
     - export SERVER_API_TOKEN=test_token

diff --git a/...ion-0.6.1/for_developers/api_reference.md → ...ion-0.6.2/for_developers/api_reference.md b/...ion-0.6.1/for_developers/api_reference.md → ...ion-0.6.2/for_developers/api_reference.md
diff --git a/.../for_developers/api_reference/rest_api.md → .../for_developers/api_reference/rest_api.md b/.../for_developers/api_reference/rest_api.md → .../for_developers/api_reference/rest_api.md
diff --git a/...rsion-0.6.1/for_developers/design_docs.md → ...rsion-0.6.2/for_developers/design_docs.md b/...rsion-0.6.1/for_developers/design_docs.md → ...rsion-0.6.2/for_developers/design_docs.md
diff --git a/...on-0.6.1/for_developers/metrics_design.md → ...on-0.6.2/for_developers/metrics_design.md b/...on-0.6.1/for_developers/metrics_design.md → ...on-0.6.2/for_developers/metrics_design.md
diff --git a/...version-0.6.1/for_developers/releasing.md → ...version-0.6.2/for_developers/releasing.md b/...version-0.6.1/for_developers/releasing.md → ...version-0.6.2/for_developers/releasing.md
diff --git a/...ion-0.6.1/getting_started/architecture.md → ...ion-0.6.2/getting_started/architecture.md b/...ion-0.6.1/getting_started/architecture.md → ...ion-0.6.2/getting_started/architecture.md
diff --git a/...n-0.6.1/getting_started/authentication.md → ...n-0.6.2/getting_started/authentication.md b/...n-0.6.1/getting_started/authentication.md → ...n-0.6.2/getting_started/authentication.md
diff --git a/...-0.6.1/getting_started/components/file.md → ...-0.6.2/getting_started/components/file.md b/...-0.6.1/getting_started/components/file.md → ...-0.6.2/getting_started/components/file.md
diff --git a/...n-0.6.1/getting_started/components/hls.md → ...n-0.6.2/getting_started/components/hls.md b/...n-0.6.1/getting_started/components/hls.md → ...n-0.6.2/getting_started/components/hls.md
diff --git a/...1/getting_started/components/recording.md → ...2/getting_started/components/recording.md b/...1/getting_started/components/recording.md → ...2/getting_started/components/recording.md
diff --git a/...-0.6.1/getting_started/components/rtsp.md → ...-0.6.2/getting_started/components/rtsp.md b/...-0.6.1/getting_started/components/rtsp.md → ...-0.6.2/getting_started/components/rtsp.md
@@ -69,7 +69,7 @@ docker run -p 20000:20000/udp \
            -p 8080:8080/tcp \
            -e FJ_SERVER_API_TOKEN=token \
            -e FJ_HOST=localhost:8080 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 :::caution
@@ -87,5 +87,5 @@ Using host network (Linux only)
 docker run --network=host \
            -e FJ_SERVER_API_TOKEN=token \
            -e FJ_HOST=localhost:8080 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
diff --git a/...n-0.6.1/getting_started/components/sip.md → ...n-0.6.2/getting_started/components/sip.md b/...n-0.6.1/getting_started/components/sip.md → ...n-0.6.2/getting_started/components/sip.md
diff --git a/...ion-0.6.1/getting_started/installation.md → ...ion-0.6.2/getting_started/installation.md b/...ion-0.6.1/getting_started/installation.md → ...ion-0.6.2/getting_started/installation.md
@@ -83,7 +83,7 @@ need to set a couple of [environment variables](#environment-variables).
 An example docker command running bare Fishjam HTTP service locally:
 
 ```bash
-docker run -p 8080:8080/tcp -e FJ_HOST=localhost:8080 -e FJ_SERVER_API_TOKEN=token ghcr.io/fishjam-dev/fishjam:0.5.0
+docker run -p 8080:8080/tcp -e FJ_HOST=localhost:8080 -e FJ_SERVER_API_TOKEN=token ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 Note that in real case scenarios, docker commands depend on peers/components you are going to use.
@@ -169,6 +169,10 @@ Defaults to `127.0.0.1` when running from source or using `mix release`, or `0.0
 * `FJ_METRICS_PORT` - a port to run metrics endpoint on.<br/>
 Defaults to `9568`.
 
+* `FJ_LOG_LEVEL` - level of logs below which all logs will not be displayed. <br/>
+Defaults to `info`.<br/>
+All possible values are: `error`, `warning`, `info`, `debug`.
+
 * `FJ_STRUCTURED_LOGGING` - whether to enable JSON-structured logging to stdout.<br/>
 Defaults to `false`.<br/>
 Possible values of the `severity` field (ordered by importance) are:

diff --git a/.../version-0.6.1/getting_started/metrics.md → .../version-0.6.2/getting_started/metrics.md b/.../version-0.6.1/getting_started/metrics.md → .../version-0.6.2/getting_started/metrics.md
diff --git a/...on-0.6.1/getting_started/notifications.md → ...on-0.6.2/getting_started/notifications.md b/...on-0.6.1/getting_started/notifications.md → ...on-0.6.2/getting_started/notifications.md
diff --git a/...ion-0.6.1/getting_started/peers/webrtc.md → ...ion-0.6.2/getting_started/peers/webrtc.md b/...ion-0.6.1/getting_started/peers/webrtc.md → ...ion-0.6.2/getting_started/peers/webrtc.md
@@ -50,7 +50,7 @@ docker run -p 50000-50050:50000-50050/udp \
            -e FJ_WEBRTC_TURN_PORT_RANGE=50000-50050 \
            -e FJ_WEBRTC_TURN_IP=192.168.0.1 \
            -e FJ_WEBRTC_TURN_LISTEN_IP=0.0.0.0 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 :::caution
@@ -69,5 +69,5 @@ docker run --network=host \
            -e FJ_WEBRTC_USED=true \
            -e FJ_WEBRTC_TURN_IP=192.168.0.1 \
            -e FJ_WEBRTC_TURN_LISTEN_IP=0.0.0.0 \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
diff --git a/...ocs/version-0.6.1/getting_started/room.md → ...ocs/version-0.6.2/getting_started/room.md b/...ocs/version-0.6.1/getting_started/room.md → ...ocs/version-0.6.2/getting_started/room.md
@@ -8,7 +8,7 @@ The holder for peers and components.
 
 * `roomId` (string, default: null) - Custom ID used for identifying the room within Fishjam.
   Must be unique across all rooms. If not provided, a random UUID will be generated. 
-  It may contain only alphanumeric characters and hyphens.
+  It may contain only alphanumeric characters, hyphens and underscores.
 
 * `maxPeers` (integer 1.., default: null) - Maximum number of peers allowed in the room.
   If set to null (default), the number of peers is unlimited.

diff --git a/...ocs/version-0.6.1/getting_started/sdks.md → ...ocs/version-0.6.2/getting_started/sdks.md b/...ocs/version-0.6.1/getting_started/sdks.md → ...ocs/version-0.6.2/getting_started/sdks.md
diff --git a/...sion-0.6.1/introduction/basic_concepts.md → ...sion-0.6.2/introduction/basic_concepts.md b/...sion-0.6.1/introduction/basic_concepts.md → ...sion-0.6.2/introduction/basic_concepts.md
diff --git a/...n-0.6.1/introduction/example_scenarios.md → ...n-0.6.2/introduction/example_scenarios.md b/...n-0.6.1/introduction/example_scenarios.md → ...n-0.6.2/introduction/example_scenarios.md
diff --git a/...ion-0.6.1/introduction/what_is_fishjam.md → ...ion-0.6.2/introduction/what_is_fishjam.md b/...ion-0.6.1/introduction/what_is_fishjam.md → ...ion-0.6.2/introduction/what_is_fishjam.md
diff --git a/...ioned_docs/version-0.6.1/release_notes.md → ...ioned_docs/version-0.6.2/release_notes.md b/...ioned_docs/version-0.6.1/release_notes.md → ...ioned_docs/version-0.6.2/release_notes.md
@@ -1,13 +1,19 @@
 # Release Notes
 
+## 0.6.2 - 22.05.2024
+
+### Features
+* Log level may now be configured using the `FJ_LOG_LEVEL` env variable
+* Room IDs may now contain underscores as well as alphanumeric characters and hyphens
+
 ## 0.6.1 - 17.05.2024
 
 ### Bugfixes
 * Fallback to `JF_*` env vars when `FJ_*` ones are missing in all cases.
 
 ## 0.6.0 - 16.05.2024
 
-### Features:
+### Features
 * Rebranding: Jellyfish -> Fishjam. All env vars have been renamed from `JF_*` to `FJ_*`.
 When a new env var is not set, an old one is tried.
 This behaviour will be removed in version 0.8.0. **[BREAKING]**
@@ -103,4 +109,4 @@ clearing or updating env vars when running from source on macOS. See [here](./ge
 * tests fixes and stability improvements
 * fixed URL to Jellydashboard
 * **prevent from unauthorized access to system files via REST API**
-* fixed Prometheus metrics resolution - Prometheus metrics are now updated as soon as an event occurs instead of every X seconds
+* fixed Prometheus metrics resolution - Prometheus metrics are now updated as soon as an event occurs instead of every X seconds
diff --git a/.../version-0.6.1/tutorials/ImageWrapper.tsx → .../version-0.6.2/tutorials/ImageWrapper.tsx b/.../version-0.6.1/tutorials/ImageWrapper.tsx → .../version-0.6.2/tutorials/ImageWrapper.tsx
diff --git a/...utorials/common/_fishjam-architecture.mdx → ...utorials/common/_fishjam-architecture.mdx b/...utorials/common/_fishjam-architecture.mdx → ...utorials/common/_fishjam-architecture.mdx
diff --git a/.../tutorials/common/_starting-dashboard.mdx → .../tutorials/common/_starting-dashboard.mdx b/.../tutorials/common/_starting-dashboard.mdx → .../tutorials/common/_starting-dashboard.mdx
diff --git a/...common/_starting-fishjam-media-server.mdx → ...common/_starting-fishjam-media-server.mdx b/...common/_starting-fishjam-media-server.mdx → ...common/_starting-fishjam-media-server.mdx
@@ -11,7 +11,7 @@ docker run -p 50000-50050:50000-50050/udp \
            -e FJ_WEBRTC_TURN_IP=<your ip address> \
            -e FJ_WEBRTC_TURN_LISTEN_IP=0.0.0.0 \
            -e FJ_SERVER_API_TOKEN=development \
-           ghcr.io/fishjam-dev/fishjam:0.5.0
+           ghcr.io/fishjam-dev/fishjam:0.6.2
 ```
 
 Make sure to set `FJ_WEBRTC_TURN_IP` and `FJ_HOST` to your local IP address. Without it, the mobile device won't be able to connect to the Fishjam.

diff --git a/...ocs/version-0.6.1/tutorials/dashboard.mdx → ...ocs/version-0.6.2/tutorials/dashboard.mdx b/...ocs/version-0.6.1/tutorials/dashboard.mdx → ...ocs/version-0.6.2/tutorials/dashboard.mdx
diff --git a/.../version-0.6.1/tutorials/react-native.mdx → .../version-0.6.2/tutorials/react-native.mdx b/.../version-0.6.1/tutorials/react-native.mdx → .../version-0.6.2/tutorials/react-native.mdx
diff --git a/...on-0.6.1/tutorials/server_sdk_examples.md → ...on-0.6.2/tutorials/server_sdk_examples.md b/...on-0.6.1/tutorials/server_sdk_examples.md → ...on-0.6.2/tutorials/server_sdk_examples.md
diff --git a/...sion-0.6.1/tutorials/simple-react-app.mdx → ...sion-0.6.2/tutorials/simple-react-app.mdx b/...sion-0.6.1/tutorials/simple-react-app.mdx → ...sion-0.6.2/tutorials/simple-react-app.mdx
diff --git a/...oned_sidebars/version-0.6.1-sidebars.json → ...oned_sidebars/version-0.6.2-sidebars.json b/...oned_sidebars/version-0.6.1-sidebars.json → ...oned_sidebars/version-0.6.2-sidebars.json
diff --git a/versions.json b/versions.json
@@ -1,5 +1,5 @@
 [
-  "0.6.1",
+  "0.6.2",
   "0.5.0",
   "0.4.2",
   "0.3.0",