add script for setup on a server

Uniswap · Mar 3, 2025 · 13f3f8b · 13f3f8b
1 parent e576430
commit 13f3f8b
Show file tree

Hide file tree

Showing 2 changed files with 214 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -312,6 +312,78 @@ Message Types:
 - Husky for Git hooks
 - lint-staged for pre-commit checks
 
+## Deployment
+
+The project includes a setup script for deploying to a cloud server with automatic HTTPS configuration using Let's Encrypt.
+
+### Prerequisites
+
+- A domain name pointing to your server (A record)
+- Ubuntu-based cloud server
+- SSH access to the server
+
+### Deployment Steps
+
+1. SSH into your server:
+```bash
+ssh user@your-server
+```
+
+2. Clone the repository:
+```bash
+git clone https://github.com/Uniswap/neutrofill.git
+cd neutrofill
+```
+
+3. Run the setup script with your domain and IP:
+```bash
+./scripts/setup-server.sh your-domain.com your-server-ip
+```
+
+For example:
+```bash
+./scripts/setup-server.sh neutrofill.com 167.172.1.91
+```
+
+The script will:
+- Install required dependencies (Node.js, nginx, certbot)
+- Set up the project in /opt/neutrofill
+- Configure nginx with WebSocket support
+- Set up SSL certificates with Let's Encrypt
+- Create and enable a systemd service
+- Start the server
+
+### Monitoring
+
+Monitor the server status:
+```bash
+sudo systemctl status neutrofill
+```
+
+View server logs:
+```bash
+sudo journalctl -u neutrofill -f
+```
+
+### Testing Deployed Server
+
+Test WebSocket connection:
+```bash
+wscat -c wss://your-domain.com/ws
+```
+
+Test broadcast endpoint:
+```bash
+curl -X POST https://your-domain.com/broadcast \
+-H "Content-Type: application/json" \
+-d '{ ... your payload ... }'
+```
+
+Test health endpoint:
+```bash
+curl https://your-domain.com/health
+```
+
 ## License
 
 MIT
diff --git a/scripts/setup-server.sh b/scripts/setup-server.sh
@@ -0,0 +1,142 @@
+#!/bin/bash
+
+# Check if domain and IP are provided
+if [ "$#" -ne 2 ]; then
+    echo "Usage: $0 <domain> <ip>"
+    echo "Example: $0 neutrofill.com 167.172.1.91"
+    exit 1
+fi
+
+DOMAIN=$1
+IP=$2
+PROJECT_DIR="/opt/neutrofill"
+
+# Update system and install dependencies
+echo "Updating system and installing dependencies..."
+sudo apt-get update
+sudo apt-get upgrade -y
+sudo apt-get install -y curl git nginx certbot python3-certbot-nginx
+
+# Install Node.js 20.x
+echo "Installing Node.js..."
+curl -fsSL https://deb.nodesource.com/setup_20.x | sudo -E bash -
+sudo apt-get install -y nodejs
+
+# Create and prepare project directory
+echo "Setting up project directory..."
+sudo mkdir -p $PROJECT_DIR
+sudo chown -R $USER:$USER $PROJECT_DIR
+
+# Copy current repository to project directory
+echo "Copying repository..."
+cp -r . $PROJECT_DIR/
+cd $PROJECT_DIR
+
+# Install dependencies and build
+echo "Installing dependencies and building..."
+npm run build
+
+# Create systemd service
+echo "Creating systemd service..."
+sudo tee /etc/systemd/system/neutrofill.service > /dev/null << EOL
+[Unit]
+Description=Neutrofill Server
+After=network.target
+
+[Service]
+Type=simple
+User=$USER
+WorkingDirectory=$PROJECT_DIR
+ExecStart=/usr/bin/node dist/server/index.js
+Restart=always
+RestartSec=10
+StandardOutput=syslog
+StandardError=syslog
+SyslogIdentifier=neutrofill
+Environment="NODE_ENV=production"
+
+[Install]
+WantedBy=multi-user.target
+EOL
+
+# Configure nginx
+echo "Configuring nginx..."
+sudo tee /etc/nginx/sites-available/neutrofill > /dev/null << EOL
+map \$http_upgrade \$connection_upgrade {
+    default upgrade;
+    '' close;
+}
+
+server {
+    server_name $DOMAIN;
+    listen 80;
+    listen [::]:80;
+
+    root $PROJECT_DIR/dist/client;
+    index index.html;
+
+    location / {
+        try_files \$uri \$uri/ /index.html;
+    }
+
+    location /broadcast {
+        proxy_pass http://localhost:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Host \$host;
+        proxy_set_header X-Real-IP \$remote_addr;
+        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto \$scheme;
+    }
+
+    location /health {
+        proxy_pass http://localhost:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Host \$host;
+        proxy_set_header X-Real-IP \$remote_addr;
+        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto \$scheme;
+    }
+
+    location /ws {
+        proxy_pass http://localhost:3000;
+        proxy_http_version 1.1;
+        proxy_set_header Upgrade \$http_upgrade;
+        proxy_set_header Connection \$connection_upgrade;
+        proxy_set_header Host \$host;
+        proxy_set_header X-Real-IP \$remote_addr;
+        proxy_set_header X-Forwarded-For \$proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto \$scheme;
+    }
+}
+EOL
+
+# Enable nginx site
+sudo ln -sf /etc/nginx/sites-available/neutrofill /etc/nginx/sites-enabled/
+sudo rm -f /etc/nginx/sites-enabled/default
+
+# Update DNS A record
+echo "Please ensure the following DNS record is set:"
+echo "$DOMAIN. A $IP"
+echo "Press Enter when DNS is configured..."
+read
+
+# Set up SSL with Let's Encrypt
+echo "Setting up SSL certificate..."
+sudo certbot --nginx -d $DOMAIN --non-interactive --agree-tos --email [email protected]
+
+# Start services
+echo "Starting services..."
+sudo systemctl daemon-reload
+sudo systemctl enable neutrofill
+sudo systemctl start neutrofill
+sudo systemctl restart nginx
+
+echo "Setup complete!"
+echo "Your server is now running at https://$DOMAIN"
+echo "WebSocket endpoint: wss://$DOMAIN/ws"
+echo "Broadcast endpoint: https://$DOMAIN/broadcast"
+echo "Health check endpoint: https://$DOMAIN/health"
+echo ""
+echo "You can monitor the server with:"
+echo "sudo systemctl status neutrofill"
+echo "sudo journalctl -u neutrofill -f"