Deployment Guide

This guide covers different deployment strategies and best practices for deploying your site using nsyte.

Basic Deployment

The simplest way to deploy your site is using the deploy command:

nsyte deploy ./dist

This will:

1. Upload your files to configured relays
2. Publish to configured blossom servers
3. Update your site's metadata

Deployment Strategies

1. Manual Deployment

Suitable for:

• Small sites
• Infrequent updates
• Personal projects

Steps:

1. Build your site
2. Run nsyte deploy
3. Verify the deployment

2. Automated Deployment

Suitable for:

• Team projects
• Frequent updates
• Production sites

Options:

• GitHub Actions
• GitLab CI
• Custom scripts

See CI/CD Guide for detailed setup instructions.

3. Staged Deployment

Suitable for:

• Large sites
• Critical applications
• Testing environments

Steps:

1. Deploy to staging relays
2. Test the deployment
3. Deploy to production

Deployment Options

Basic Deploy

nsyte deploy ./dist

Force Re-deploy

Bypass server preflight checks and re-upload all files:

nsyte deploy ./dist --force

Sync Missing Files

Check all servers and upload any missing blobs:

nsyte deploy ./dist --sync

Set Concurrency

nsyte deploy ./dist --concurrency 8

SPA Support

nsyte deploy ./dist --fallback=/index.html

Deployment Checklist

Before deploying:

1. Configuration

   • [ ] Verify relay configuration
   • [ ] Check server settings
   • [ ] Review ignore patterns

2. Authentication

   • [ ] Ensure proper authentication
   • [ ] Verify bunker connection
   • [ ] Check key permissions

3. Content

   • [ ] Build site
   • [ ] Test locally
   • [ ] Check file sizes
   • [ ] Verify links

4. Deployment

   • [ ] Backup current site
   • [ ] Run deploy
   • [ ] Verify deployment
   • [ ] Check site metadata

Best Practices

1. Performance

• Optimize images and assets
• Use appropriate file formats
• Enable compression
• Implement caching

2. Reliability

• Use multiple relays
• Configure fallback servers
• Monitor deployment status
• Keep backups

3. Security

• Use secure authentication
• Protect sensitive data
• Regular key rotation
• Monitor access

4. Maintenance

• Regular updates
• Monitor site health
• Clean up old files
• Update dependencies

Troubleshooting

Common Issues

1. Deploy Failures

   • Check network connectivity
   • Verify relay liveness
   • Ensure you are allowed to publish to provided relays
   • Ensure that provided relays are not rate-limited.
   • Check authentication

2. Missing Files

   • Review ignore patterns
   • Check file paths
   • Verify build output

3. Authentication Errors

   • Verify keys
   • Check bunker connection
   • Review bunker permissions
   • Check configuration

Getting Help

• Check the GitHub Issues
• Review the Security Guide

Next Steps

• Set up CI/CD integration
• Review security best practices
• Learn about local development