Skip to content

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 upload command:

nsyte upload ./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 upload
  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 Upload

nsyte upload ./dist

Force Re-upload

nsyte upload ./dist --force

Purge Deleted Files

nsyte upload ./dist --purge

Set Concurrency

nsyte upload ./dist --concurrency 8

SPA Support

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

Deployment Checklist

Before deploying:

  1. Configuration
  2. [ ] Verify relay configuration
  3. [ ] Check server settings

  4. [ ] Review ignore patterns

  5. Authentication

  6. [ ] Ensure proper authentication
  7. [ ] Verify bunker connection

  8. [ ] Check key permissions

  9. Content

  10. [ ] Build site
  11. [ ] Test locally
  12. [ ] Check file sizes

  13. [ ] Verify links

  14. Deployment

  15. [ ] Backup current site
  16. [ ] Run upload
  17. [ ] Verify deployment
  18. [ ] 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. Upload Failures
  2. Check network connectivity
  3. Verify relay liveness
  4. Ensure you are allowed to publish to provided relays
  5. Ensure that provided relays are not rate-limited.

  6. Check authentication

  7. Missing Files

  8. Review ignore patterns
  9. Check file paths

  10. Verify build output

  11. Authentication Errors

  12. Verify keys
  13. Check bunker connection
  14. Review bunker permissions
  15. Check configuration

Getting Help

Next Steps