commit 5876c48709cf5d7468f1fd2800c0aa82e271e7fe · cduck.me/statusphere-example-app-fork

+34
README.md
···

       19
       19
        
       npm run dev

     

       20
       20
        
       # Navigate to http://localhost:8080

     

       21
       21
        
       ```

     

       22
       22
       +
       

     

       23
       23
       +
       ## Deploying

     

       24
       24
       +
       

     

       25
       25
       +
       In production, you will need a private key to sign OAuth tokens request. Use the

     

       26
       26
       +
       following command to generate a new JWK (JSON Web Key):

     

       27
       27
       +
       

     

       28
       28
       +
       ```sh

     

       29
       29
       +
       ./bin/gen-jwk

     

       30
       30
       +
       ```

     

       31
       31
       +
       

     

       32
       32
       +
       The generated key must be added to the environment variables (`.env` file) as `PRIVATE_KEY`.

     

       33
       33
       +
       

     

       34
       34
       +
       ```env

     

       35
       35
       +
       PRIVATE_KEYS='[{"kty":"EC","kid":"12",...}]'

     

       36
       36
       +
       ```

     

       37
       37
       +
       

     

       38
       38
       +
       Note that you can have multiple keys. Always add new keys at the beginning of

     

       39
       39
       +
       the array, so that the first key is always the most recent one. When a key is

     

       40
       40
       +
       removed, all associated sessions will be invalidated.

     

       41
       41
       +
       

     

       42
       42
       +
       Make sure to also set the `COOKIE_SECRET` in your environment variables (`.env` file), which is used to sign session cookies. You can generate a random string for this:

     

       43
       43
       +
       

     

       44
       44
       +
       ```sh

     

       45
       45
       +
       openssl rand -base64 33

     

       46
       46
       +
       ```

     

       47
       47
       +
       

     

       48
       48
       +
       Finally, set the `PUBLIC_URL` to the URL where your app will be accessible. This is used for OAuth client ID and other configurations.

     

       49
       49
       +
       

     

       50
       50
       +
       ```env

     

       51
       51
       +
       PUBLIC_URL="https://your-app-url.com"

     

       52
       52
       +
       ```

     

       53
       53
       +
       

     

       54
       54
       +
       > [!NOTE]

     

       55
       55
       +
       > You can use services like [ngrok](https://ngrok.com/) to expose your local server to the internet for testing purposes. Just set the `PUBLIC_URL` to the ngrok URL.