Lanyards is a dedicated profile for researchers, built on the AT Protocol.
1# Lanyards Setup Guide
2
3## Quick Start with App Password (Recommended for Development)
4
5### 1. Create a Bluesky App Password
6
71. Go to [https://bsky.app/settings/app-passwords](https://bsky.app/settings/app-passwords)
82. Click "Add App Password"
93. Give it a name (e.g., "Lanyards Development")
104. Copy the generated password
11
12### 2. Configure Environment Variables
13
141. Copy the example environment file:
15 ```bash
16 cp .env.example .env
17 ```
18
192. Edit `.env` and add your credentials:
20 ```env
21 # Set authentication method to app_password
22 AUTH_METHOD=app_password
23
24 # Add your Bluesky credentials
25 BLUESKY_HANDLE=your-handle.bsky.social
26 BLUESKY_APP_PASSWORD=your-app-password-here
27
28 # Leave these as-is for now
29 NEXT_PUBLIC_APP_URL=http://localhost:3000
30 PDS_URL=https://bsky.social
31 ```
32
33### 3. Install Dependencies
34
35```bash
36npm install
37```
38
39### 4. Run the Development Server
40
41```bash
42npm run dev
43```
44
45Visit [http://localhost:3000](http://localhost:3000) and click "Sign In". You'll be automatically authenticated with your configured account.
46
47## Authentication Methods
48
49Lanyards supports two authentication methods:
50
51### App Password (Development)
52- **Pros**: Simple setup, no OAuth configuration needed
53- **Cons**: Single account only, credentials in .env file
54- **Use for**: Local development and testing
55- **Configuration**: Set `AUTH_METHOD=app_password` in `.env`
56
57### OAuth (Production)
58- **Pros**: Multi-user support, secure authorization flow
59- **Cons**: Requires OAuth client setup and configuration
60- **Use for**: Production deployment
61- **Configuration**: Set `AUTH_METHOD=oauth` in `.env`
62
63## Switching Between Authentication Methods
64
65Simply change the `AUTH_METHOD` value in your `.env` file:
66
67```env
68# For App Password
69AUTH_METHOD=app_password
70
71# For OAuth
72AUTH_METHOD=oauth
73```
74
75Restart the development server after changing the method.
76
77## Setting Up OAuth (Production)
78
79Coming soon - OAuth setup requires AT Protocol OAuth client configuration.
80
81## Troubleshooting
82
83### "App password not configured" error
84- Check that `BLUESKY_HANDLE` and `BLUESKY_APP_PASSWORD` are set in `.env`
85- Ensure there are no extra spaces or quotes around the values
86- Restart the development server after changing `.env`
87
88### Authentication fails
89- Verify your app password is correct
90- Make sure your Bluesky account is active
91- Check that `PDS_URL` is set to `https://bsky.social`
92
93### Can't access dashboard
94- Make sure you're signed in (check for session cookie)
95- Try clearing cookies and signing in again
96- Check the browser console for errors
97
98## Next Steps
99
100Once authenticated, you can:
1011. View your dashboard at `/dashboard`
1022. Add affiliations, publications, and events
1033. Configure your profile settings
1044. View your public profile at `/{your-handle}`