https://github.com/ngmy/webloyer
Webloyer is a web UI for managing Deployer deployments
https://github.com/ngmy/webloyer
deployer deployment laravel php tool webloyer webui
Last synced: 2 months ago
JSON representation
Webloyer is a web UI for managing Deployer deployments
- Host: GitHub
- URL: https://github.com/ngmy/webloyer
- Owner: ngmy
- License: mit
- Created: 2015-05-02T09:30:54.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2022-11-05T17:59:44.000Z (over 2 years ago)
- Last Synced: 2025-03-30T01:11:10.806Z (3 months ago)
- Topics: deployer, deployment, laravel, php, tool, webloyer, webui
- Language: PHP
- Homepage:
- Size: 2.03 MB
- Stars: 217
- Watchers: 8
- Forks: 34
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Webloyer
[](https://packagist.org/packages/ngmy/webloyer)
[](https://packagist.org/packages/ngmy/webloyer)
[](https://packagist.org/packages/ngmy/webloyer)
[](https://packagist.org/packages/ngmy/webloyer)
[](https://travis-ci.org/ngmy/webloyer)
[](https://coveralls.io/r/ngmy/webloyer?branch=master)
Webloyer is a Web UI for managing [Deployer](https://github.com/deployphp/deployer) deployments.
## Features
Webloyer has the following features:
* Project management
* Managing deployment settings on a project-by-project basis
* Deployment management on a project-by-project basis
* 1-click deploying and rolling back
* Keeping a log of every deployments
* E-mail notifications can be sent when a deployment finishes
* Recipe management
* Creating, editing, deleting and listing recipe files
* Server management
* Creating, editing, deleting and listing server list files
* User management
* Authentication with e-mail address and password
* Role-based access control to features
* Web APIs
* Webhooks
* GitHub
## Screenshots
See [screenshots](/SCREENSHOTS.md).
## Requirements
Webloyer has the following requirements:
* PHP >= 5.6.0
* OpenSSL PHP Extension
* PDO PHP Extension
* Mbstring PHP Extension
* Tokenizer PHP Extension
## Installation
### Option 1: Download Source Code
1. Download the application source code by using the Composer `create-project` command:
```
composer create-project ngmy/webloyer
```
2. Give write permission to the `storage` directory and the `bootstrap/cache` directory for your web server user (e.g. `www-data`) by running the following command:
```
chown -R www-data:www-data storage
chown -R www-data:www-data bootstrap/cache
```
3. Run the installer by using the Artisan `webloyer:install` command:
```
php artisan webloyer:install
```
**Note:** You must be running this command as your web server user.
4. Start the queue listener as a background process by using the Artisan `queue:listen` command:
```
nohup php artisan queue:listen --timeout=0 &
```
**Note:** You must be running this command as your web server user.
5. Add the following Cron entry to your server:
```
* * * * * php /path/to/webloyer/artisan schedule:run >> /dev/null 2>&1
```
**Note:** You must be running this Cron entry as your web server user.
### Option 2: Using Docker
You can also install using [Webloyer Docker](https://github.com/ngmy/webloyer-docker).
## Basic Usage
### Step 1: Login to Webloyer
1. Go to the Login page by click the "Login" link.
2. Enter the e-mail address and password.
3. Click the "Login" button to login to Webloyer.
### Step 2: Create Your Project
1. Go to the Create Project page by click the "Create" button in the Projects page.
2. Enter your project information.
**Note:** For now, Webloyer only supports the `deploy` task and the `rollback` task. Therefore, you must define these tasks in your Deployer recipe file.
**Note:** If you want to use the e-mail notification, you need to enter your e-mail settings from the E-Mail Settings page.
3. Click the "Store" button to finish project creation process.
### Step 3: Managing Deployments
1. Go to the Deployments page by click the "Deployments" button.
2. Run the `deploy` task by click the "Deploy" button. Or run the `rollback` task by click the "Rollback" button.
3. After the task of execution has been completed, it is possible to go to the Deployment Detail page by click the "Show" button, you can see the details of the task execution results.
## Advanced Usage
* [Web APIs](/WEBAPIS.md)
* [Webhooks](/WEBHOOKS.md)
## Foundation Library
Webloyer uses [Laravel](http://laravel.com/) as a foundation PHP framework.
## License
Webloyer is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
## Donation
Do you want to buy me a coffee?
[](https://flattr.com/submit/auto?fid=513grl&url=https%3A%2F%2Fgithub.com%2Fngmy%2Fwebloyer)