↓Skip to main content
IT Blog IT Blog
  1. All Posts/

webloyer

Tools PHP

Webloyer







Webloyer is a Web UI for managing 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.

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

    <p>
  <strong>Note:</strong> You must be running this command as your web server user.</li> 
  
  <li>
    Start the queue listener as a background process by using the Artisan <code>queue:listen</code> command: <pre class="notranslate"><code>nohup php artisan queue:listen --timeout=0 &


        <p>
      <strong>Note:</strong> You must be running this command as your web server user.</li> 
      
      <li>
        Add the following Cron entry to your server: <pre class="notranslate"><code>* * * * * php /path/to/webloyer/artisan schedule:run &gt;&gt; /dev/null 2&gt;&1


            <p>
          <strong>Note:</strong> You must be running this Cron entry as your web server user.</li> </ol> 
          
          <h3 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-option-2-using-docker" class="anchor" aria-hidden="true" href="#option-2-using-docker"></a>Option 2: Using Docker
          </h3>
          
          <p>
            You can also install using Webloyer Docker.
          </p>
          
          <h2 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-basic-usage" class="anchor" aria-hidden="true" href="#basic-usage"></a>Basic Usage
          </h2>
          
          <h3 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-step-1-login-to-webloyer" class="anchor" aria-hidden="true" href="#step-1-login-to-webloyer"></a>Step 1: Login to Webloyer
          </h3>
          
          <ol dir="auto">
            <li>
              Go to the Login page by click the &#8220;Login&#8221; link.
            </li>
            <li>
              Enter the e-mail address and password.
            </li>
            <li>
              Click the &#8220;Login&#8221; button to login to Webloyer.
            </li>
          </ol>
          
          <h3 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-step-2-create-your-project" class="anchor" aria-hidden="true" href="#step-2-create-your-project"></a>Step 2: Create Your Project
          </h3>
          
          <ol dir="auto">
            <li>
              Go to the Create Project page by click the &#8220;Create&#8221; button in the Projects page.
            </li>
            <li>
              Enter your project information.<br /> <strong>Note:</strong> For now, Webloyer only supports the <code>deploy</code> task and the <code>rollback</code> task. Therefore, you must define these tasks in your Deployer recipe file.<br /> <strong>Note:</strong> If you want to use the e-mail notification, you need to enter your e-mail settings from the E-Mail Settings page.
            </li>
            <li>
              Click the &#8220;Store&#8221; button to finish project creation process.
            </li>
          </ol>
          
          <h3 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-step-3-managing-deployments" class="anchor" aria-hidden="true" href="#step-3-managing-deployments"></a>Step 3: Managing Deployments
          </h3>
          
          <ol dir="auto">
            <li>
              Go to the Deployments page by click the &#8220;Deployments&#8221; button.
            </li>
            <li>
              Run the <code>deploy</code> task by click the &#8220;Deploy&#8221; button. Or run the <code>rollback</code> task by click the &#8220;Rollback&#8221; button.
            </li>
            <li>
              After the task of execution has been completed, it is possible to go to the Deployment Detail page by click the &#8220;Show&#8221; button, you can see the details of the task execution results.
            </li>
          </ol>
          
          <h2 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-advanced-usage" class="anchor" aria-hidden="true" href="#advanced-usage"></a>Advanced Usage
          </h2>
          
          <ul dir="auto">
            <li>
              Web APIs
            </li>
            <li>
              Webhooks
            </li>
          </ul>
          
          <h2 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-foundation-library" class="anchor" aria-hidden="true" href="#foundation-library"></a>Foundation Library
          </h2>
          
          <p>
            Webloyer uses <a rel="nofollow noopener" target="_blank" href="http://laravel.com/">Laravel</a> as a foundation PHP framework.
          </p>
          
          <h2 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-license" class="anchor" aria-hidden="true" href="#license"></a>License
          </h2>
          
          <p>
            Webloyer is open-sourced software licensed under the <a rel="nofollow noopener" target="_blank" href="http://opensource.org/licenses/MIT">MIT license</a>.
          </p>
          
          <h2 dir="auto">
            <a rel="nofollow noopener" target="_blank" id="user-content-donation" class="anchor" aria-hidden="true" href="#donation"></a>Donation
          </h2>
          
          <p>
            Do you want to buy me a coffee?
          </p>


↑