aturi.to
Universal links for the ATmosphere
Fork aturi.to
Run your own ATProto link sharing service with a custom domain
Why Fork?
Community-Specific
Create a version tailored to your community with custom branding and curated platforms.
Regional Optimization
Host closer to your users for faster load times and better performance.
Full Control
Self-host on your infrastructure with complete control over features and data.
Quick Start
Get your instance up and running in just a few minutes
Interactive Setup (Recommended)
# Clone the repository git clone https://github.com/yourusername/aturi-to.git my-instance cd my-instance # Run interactive setup npm run setup-fork # Install and start npm install npm run dev
The setup script will ask for your domain, name, and preferences, then create a.env.localfile with your configuration.
Configuration
Customize your instance through environment variables
# .env.local NEXT_PUBLIC_DOMAIN=yourdomain.com NEXT_PUBLIC_SITE_NAME=Your Site Name NEXT_PUBLIC_SITE_DESCRIPTION=Your description NEXT_PUBLIC_AUTHOR_NAME=Your Name NEXT_PUBLIC_REPO_URL=https://github.com/you/your-fork
See .env.example for all available options.
Manual Setup
1. Clone & Configure
git clone https://github.com/yourusername/aturi-to.git cd aturi-to cp .env.example .env.local # Edit .env.local with your settings
2. Customize Waypoints
Edit src/utils/waypoints.tsx to add/remove platforms:
export const waypoints: Waypoint[] = [
{
id: 'your-platform',
name: 'Your Platform',
urlPattern: (repo, collection, rkey) => {
return `https://platform.com/${repo}/${rkey}`;
},
},
];3. Update Branding
- Replace logo in
public/ - Update colors in
src/app/globals.css - Modify metadata in
src/app/layout.tsx
4. Deploy
npm install npm run dev # Test locally # Deploy to Vercel vercel # Add env vars in Vercel dashboard # Add custom domain in Vercel settings
⚖️ GPL v3 Requirements
When forking aturi.to, you must:
- Keep your source code publicly available
- Use GPL v3 or later for your fork
- Include the LICENSE file
- Mark any changes you make
Attribution to the original project is appreciated and helps the ecosystem!
Resources
Everything you need to get started