https://github.com/atproto-os/module-atproto

AT Protocol module for OWD Client
https://github.com/atproto-os/module-atproto

atproto bluesky owd-client owd-modules owdproject

Last synced: about 2 months ago
JSON representation

AT Protocol module for OWD Client

• Host: GitHub
• URL: https://github.com/atproto-os/module-atproto
• Owner: atproto-os
• License: mit
• Created: 2025-03-28T02:39:13.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2025-06-23T22:46:31.000Z (12 months ago)
• Last Synced: 2025-10-11T12:35:09.616Z (8 months ago)
• Topics: atproto, bluesky, owd-client, owd-modules, owdproject
• Language: TypeScript
• Homepage:
• Size: 41 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

          


  



ATProto Module



  AT Protocol Module for Open Web Desktop.



## Overview

This module for Open Web Desktop enables AT Protocol integration.

Refer to the [nuxt-atproto](https://www.npmjs.com/package/nuxt-atproto) documentation for more details and options.

## Features

- Provides ATProto agent and OAuth client integration

- Generates `client-metadata.json` on the fly in `/public`

- Fetches the Open Web Desktop client account host

- Handles the AT Protocol OAuth client login

## Installation

```bash

owd install-module @owdproject/module-atproto

```

## Configuration

You could set this configuration in `/desktop/owd.config.ts`:

```json

atproto: {

  serviceEndpoint: {

    private: 'https://bsky.social',

    public: 'https://public.api.bsky.app'

  },

  oauth: {

    clientMetadata: {

      // url of your remote client_metadata.json, leave the field empty

      // to let `nuxt-atproto` generate a local /public/client_metadata.json

      remote: '',

      // configuration for the local client_metadata.json

      local: {

        client_id: 'https://nuxt-atproto.pages.dev/client-metadata.json',

        client_name: 'nuxt-atproto',

        client_uri: 'https://nuxt-atproto.pages.dev',

        logo_uri: 'https://nuxt-atproto.pages.dev/logo.png',

        tos_uri: 'https://nuxt-atproto.pages.dev',

        policy_uri: 'https://nuxt-atproto.pages.dev',

        redirect_uris: ['https://nuxt-atproto.pages.dev'],

        scope: "atproto transition:generic",

        grant_types: ["authorization_code", "refresh_token"],

        response_types: ["code"],

        token_endpoint_auth_method: 'none',

        application_type: 'web',

        dpop_bound_access_tokens: true

      }

    },

    signInOptions: {

      state: '',

      prompt: 'login',

      scope: 'atproto',

      ui_locales: 'en',

    },

  },

  debug: true,

},

atprotoDesktop: {

  owner: {

    did: 'did:plc:iaf5ejdchj6nydfxmcrq5rm6',

  },

  name: {

    title: 'atproto',

    affix: 'OS'

  },

}

```

## License

This module is released under the [MIT License](LICENSE).