![\"\"](\"https:\/\/www.pinkgold.space\/wp-content\/uploads\/2024\/09\/howtodeploykutt-rocky-225x300.jpg\")
<\/p>\n<\/p>\n
Deploying the Kutt URL shortener on Rocky Linux 9.4 (Blue Onyx) involves several steps, from setting up your server environment to configuring Docker and troubleshooting potential issues. This guide provides a comprehensive walkthrough based on personal experience to help you get Kutt up and running smoothly.<\/p>\n
First, make sure your server is up to date.<\/p>\n
sudo dnf update -y<\/code><\/pre>\nStep 2: Install Required Packages<\/h2>\n
Install Docker, Docker Compose, and other necessary packages.<\/p>\n
sudo dnf install -y docker docker-compose git<\/code><\/pre>\nStart and enable Docker service.<\/p>\n
sudo systemctl start docker\nsudo systemctl enable docker<\/code><\/pre>\nStep 3: Clone the Kutt Repository<\/h2>\n
Clone the Kutt repository from GitHub.<\/p>\n
git clone https:\/\/github.com\/thedevs-network\/kutt.git\ncd kutt<\/code><\/pre>\nStep 4: Configure Environment Variables<\/h2>\n
Create a .env<\/code> file in the root of your cloned repository and add the following configuration. Replace placeholders with your actual values.<\/p>\n# .env file\n\n# General settings\nPORT=3000\nNODE_ENV=production\nSITE_NAME=Kutt\nDEFAULT_DOMAIN=yourdomain.com\nJWT_SECRET=your_jwt_secret\n\n# PostgreSQL settings\nDB_HOST=postgres\nDB_NAME=kutt\nDB_USER=postgres\nDB_PASSWORD=your_postgres_password\n\n# Redis settings\nREDIS_HOST=redis\n\n# Gmail SMTP settings\nMAIL_HOST=smtp.gmail.com\nMAIL_PORT=587\nMAIL_SECURE=false\nMAIL_USER=your_gmail_address@gmail.com\nMAIL_PASSWORD=your_app_password\n\n# URL length\nLINK_LENGTH=6\n\n# Google Safe Browsing API (optional)\n# GOOGLE_SAFE_BROWSING_KEY=\n\n# Recaptcha (optional)\n# RECAPTCHA_SECRET_KEY=\n# RECAPTCHA_SITE_KEY=\n\n# Google Analytics (optional)\n# GA_TRACKING_ID=\n<\/code><\/pre>\nStep 5: Configure Docker Compose<\/h2>\n
Create or modify the docker-compose.yml<\/code> file to include the necessary services.<\/p>\nversion: \"3\"\n\nservices:\n kutt:\n image: kutt\/kutt\n depends_on:\n - postgres\n - redis\n command: [\".\/wait-for-it.sh\", \"postgres:5432\", \"--\", \"npm\", \"start\"]\n ports:\n - \"3000:3000\"\n env_file:\n - .env\n networks:\n - kutt_network\n\n redis:\n image: redis:6.0-alpine\n volumes:\n - redis_data:\/data\n networks:\n - kutt_network\n\n postgres:\n image: postgres:12-alpine\n environment:\n POSTGRES_USER: postgres\n POSTGRES_PASSWORD: your_postgres_password\n POSTGRES_DB: kutt\n volumes:\n - postgres_data:\/var\/lib\/postgresql\/data\n - .\/init.sql:\/docker-entrypoint-initdb.d\/init.sql\n networks:\n - kutt_network\n\nvolumes:\n redis_data:\n postgres_data:\n\nnetworks:\n kutt_network:\n driver: bridge\n<\/code><\/pre>\nStep 6: Modify Kutt Source Files<\/h2>\n
You may need to add logging and troubleshooting code. For example, in server.ts<\/code>, add logging for signup errors.<\/p>\n\/\/ server\/handlers\/auth.ts\n\nexport const signup: Handler = async (req, res) => {\n console.log(`Signup request received: ${JSON.stringify(req.body)}`);\n try {\n const salt = await bcrypt.genSalt(12);\n const password = await bcrypt.hash(req.body.password, salt);\n\n const user = await query.user.add(\n { email: req.body.email, password },\n req.user\n );\n\n await mail.verification(user);\n\n return res.status(201).send({ message: \"Verification email has been sent.\" });\n } catch (error) {\n console.error(`Error during signup: ${error.message}`);\n return res.status(500).send({ message: \"Failed to signup. Please try again later.\" });\n }\n};\n<\/code><\/pre>\nStep 7: Build and Start Docker Containers<\/h2>\n
Build and start your Docker containers.<\/p>\n
sudo docker-compose build\nsudo docker-compose up -d<\/code><\/pre>\nStep 8: Configure Firewall<\/h2>\n
Ensure your firewall allows traffic on the necessary ports.<\/p>\n
sudo firewall-cmd --permanent --add-port=3000\/tcp\nsudo firewall-cmd --permanent --add-port=5432\/tcp\nsudo firewall-cmd --permanent --add-port=6379\/tcp\nsudo firewall-cmd --permanent --add-port=587\/tcp\nsudo firewall-cmd --reload<\/code><\/pre>\nStep 9: Test the Deployment<\/h2>\n\n- Access the Kutt web interface:<\/strong> Open your browser and navigate to
http:\/\/yourdomain.com:3000<\/code>.<\/li>\n- Signup and verify:<\/strong> Register a new account and verify the email using the link sent to your email.<\/li>\n<\/ul>\n
Troubleshooting<\/h2>\n
SMTP Issues:<\/strong> If you encounter SMTP connection issues, ensure the firewall settings are correct and the SMTP credentials are accurate.<\/p>\nDatabase Connection:<\/strong> Verify PostgreSQL and Redis services are running and accessible from the Kutt container.<\/p>\nLogs:<\/strong> Check Docker logs for errors.<\/p>\nsudo docker logs st-kutt-1\nsudo docker logs st-postgres-1\nsudo docker logs st-redis-1<\/code><\/pre>\nAdditional Changes<\/h2>\n
You might need to adjust some configurations in your package.json<\/code> to ensure dependencies are installed correctly.<\/p>\n{\n \"name\": \"kutt\",\n \"version\": \"2.7.4\",\n \"scripts\": {\n \"start\": \"npm run migrate && cross-env NODE_ENV=production node production-server\/server.js\",\n \"migrate\": \"knex migrate:latest --env production\",\n \"build\": \"rimraf production-server && tsc --project tsconfig.json && copyfiles -f 'server\/mail\/*.html' production-server\/mail && next build client\/\"\n },\n \"dependencies\": {\n \"bcryptjs\": \"^2.4.3\",\n \"cross-env\": \"^7.0.3\",\n \"express\": \"^4.17.1\",\n \"knex\": \"^0.95.4\",\n \"mail\": \"^1.0.0\",\n \"next\": \"10.0.5\",\n \"nodemailer\": \"^6.6.3\",\n \"pg\": \"^8.5.1\",\n \"rimraf\": \"^3.0.2\",\n \"ts-node\": \"^9.1.1\",\n \"typescript\": \"^4.1.3\"\n }\n}\n<\/code><\/pre>\nConclusion<\/h2>\n
Deploying Kutt on Rocky Linux 9.4 involves several steps, but with the correct configurations and troubleshooting, you can get it up and running smoothly. This guide should help you navigate through the process and resolve common issues related to SMTP, Docker, and environment configurations. Happy URL shortening!<\/p>\n\n\n\n","protected":false},"excerpt":{"rendered":"