diff --git a/.github/workflows/docs-sync.yml b/.github/workflows/docs-sync.yml index 6fe0cfaea0..738203e512 100644 --- a/.github/workflows/docs-sync.yml +++ b/.github/workflows/docs-sync.yml @@ -11,6 +11,7 @@ on: jobs: sync: + if: github.repository == 'rivet-dev/actors' runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/mirror-swift.yml b/.github/workflows/mirror-swift.yml index 0d16e43061..28d6b3ad49 100644 --- a/.github/workflows/mirror-swift.yml +++ b/.github/workflows/mirror-swift.yml @@ -11,6 +11,7 @@ on: jobs: mirror: + if: github.repository == 'rivet-dev/actors' runs-on: ubuntu-latest steps: - name: Checkout diff --git a/docs/content/docs/authentication.mdx b/docs/content/docs/authentication.mdx index 1ff904881e..436f31e33c 100644 --- a/docs/content/docs/authentication.mdx +++ b/docs/content/docs/authentication.mdx @@ -8,16 +8,20 @@ skill: true + Actors are private by default on Rivet Cloud. Only requests with the publishable token can interact with actors. - **Backend-only actors**: If your publishable token is only included in your backend, then authentication is not necessary. - **Frontend-accessible actors**: If your publishable token is included in your frontend, then implementing authentication is recommended. + + Actors are public by default on self-hosted Rivet. Anyone can access them without a token. - **Only accessible within private network**: If Rivet is only accessible within your private network, then authentication is not necessary. - **Rivet exposed to the public internet**: If Rivet is configured to accept traffic from the public internet, then implementing authentication is recommended. + diff --git a/docs/content/docs/connections.mdx b/docs/content/docs/connections.mdx index 2f7ad4e3c4..a925899783 100644 --- a/docs/content/docs/connections.mdx +++ b/docs/content/docs/connections.mdx @@ -25,7 +25,9 @@ For example: There are two ways to define an actor's connection state: + + Define connection state as a constant value: @@ -34,6 +36,7 @@ There are two ways to define an actor's connection state: + Create connection state dynamically with a function called for each connection: diff --git a/docs/content/docs/crash-course.mdx b/docs/content/docs/crash-course.mdx index 4e7b05d5e9..81fc67082e 100644 --- a/docs/content/docs/crash-course.mdx +++ b/docs/content/docs/crash-course.mdx @@ -46,9 +46,12 @@ Persistent data that survives restarts, crashes, and deployments. State is persi + + + @@ -80,9 +83,12 @@ Temporary data that doesn't survive restarts. Use for non-serializable objects ( + + + @@ -114,9 +120,12 @@ Access the current connection via `c.conn` or all connected clients via `c.conns + + + @@ -186,9 +195,12 @@ Use `UserError` to throw errors that are safely returned to clients. Pass `metad + + +