Install OpenBoxes via DigitalOcean Marketplace

We’re very excited to announce that OpenBoxes can now be installed as a DigitalOcean droplet using the 1-Click App DigitalOcean Marketplace.

This makes installing OpenBoxes much easier as all of the legwork (i.e. installing dependencies, creating and populating the database, configuring the application) has been taken care of for you. You just need to create a DigitalOcean account, pick your droplet size, region, and go.

Note: You will be charged (2GB = $10 per month, 4GB = $20 per month, 4GB = $40 per month) by DigitalOcean for any droplets you create. If you are evaluating OpenBoxes make sure to delete your droplet when you are done with the evaluation. You can create a snapshot of your droplet if you plan to resume using OpenBoxes in the future.

Note: If you are just evaluating OpenBoxes, we recommend using at least a 2GB droplet ($10 per month). If you plan to run in production, we recommend using at least a 4GB droplet ($20 per month).

Getting Started

The following section will set you down the path to getting started with your first DigitalOcean droplet running OpenBoxes. The following steps may or may not be exact as DigitalOcean frequently updates their automated deployment workflow.

Create a new droplet

Step 0. Click the button

Click the Deploy to DigitalOcean button below.

Deploy to DigitalOcean

Step 1. Create or sign into your digital ocean account

The button will redirect you to DigitalOcean, where you will either need to sign in with an existing account or create a new account.

Step 2. Add a payment method

… because DigitalOcean needs to charge you for the resources you use.

Step 3. Choose options

Choose the appropriate region, data center, image, droplet type and size, and authentication mechanism,

Region

Choose the Region and Data Center closest to you and/or your users).

Data Center

Image

If you clicked the link above, you should have OpenBoxes Server 0.8.20 selected by default. If not, you should be able to search for “OpenBoxes Server” under the Marketplace tab.

Size

You can customize this as you see fit, but the options below are basically the minimum required to run OpenBoxes.

Choose Authentication Mechanism

It’s recommended that you use the SSH key option, but feel free to use a password if you feel more comfortable.

Note: You can also change the hostname and choose to enable backups (recommended for production).

Step 4. Finalize Details

Review the options you’ve selected and when you’re ready, click on the Create Droplet button.

Once that is done, you’ll be redirected to your account workspace. Wait for the droplet to be created (this might take a few minutes). When it’s done you should see your new droplet in the Droplets list.


Next Steps

Step 1. Login to OpenBoxes

  1. Click on the IP Address to copy it

  2. Open a new browser tab, paste IP Address, and click Enter

  3. Enter username admin, password password

  4. Click the Login button

  5. Choose Main Warehouse

  6. Enjoy the fleeting emptiness of your new dashboard

Step 2. Change Password

The first thing we need to do is change the default password. Otherwise everyone who knows your IP Address will be able to login with the default credentials (admin:password).

  1. Navigate to the Edit Profile page

  2. Click on the Change Password tab

  3. Enter a new password in the Password and Confirm Password fields

Step 3. Assign Organization (recommended)

One other change we need to make is setting the Organization field for the Main Warehouse.

  1. Go to Configuration > Locations

  2. Click on the Main Warehouse link to navigate to the Edit Location page

  3. Choose Main Corporation from the dropdown list

  4. Click the Save button

Step 4. Create a Product (optional)

  1. Click on the Products > Create New Product

  2. Enter the Name and Category

Note: Code will be populated automically, but you are free to use your own Product Code / SKU instead.

  1. Click the Save button at the bottom of the page.

Step 5. Record Stock (optional)

  1. Click on the Record Stock button

  2. Enter a lot number

Note: Bin locations are not supported by default. You’ll need to add one of the following supported activities (e.g. PICK_STOCK, PUTAWAY_STOCK) to the location type (Depot) or location (Main Warehouse) in order to enable bin locations AND create at least bin location under Main Warehouse in order for bin locations to be enabled.

Step 6. View Stock Card

  1. Click the Show Stock Card button

We’ve updated the OpenBoxes app version on the DigitalOcean marketplace.

To create a new droplet, click the link below and follow the instructions above.

We’d recommend choosing a droplet size with at least 4GB of RAM. You could probably get away with one of the 2GB options for a little while, but you’ll eventually need to upgrade to avoid memory errors.

All other options (Region, Data Center, Authentication Method, Hostname, etc) are completely up to you.

hi guys, how do I access the database?
where I can find username and password

By default, MySQL listens for connection on port 3306 from local clients (i.e. mysql client, JDBC client running on the droplet), so you cannot connect to the MySQL server from a remote host without configuration changes.

If you’re okay with that restriction, you can connect to the droplet via SSH and use the local MySQL client to connect to the database.

  1. Using the password (or public key) you provided when creating the droplet.

    ssh root@<ip-address-of-droplet>
    
  2. Since you’ll be logged in as root you can run the following command to access the OpenBoxes database.

    sudo mysql openboxes
    

If you need to remotely connect to the MySQL instance, you have a few options

  1. Enable remote connections How To Allow Remote Access to MySQL | DigitalOcean

    Note: It is recommended that you not expose your MySQL instance publicly. However, it’s your droplet, so it’s your choice. If you do expose it, make sure that you enable firewall rules (ufw) to allow traffic over 3306 to just your specific IP addresses and create MySQL accounts with non-default passwords (i.e. don’t use root / root or openboxes / openboxes).

  2. Use SSH tunneling How to Connect to a MySQL Server Remotely with MySQL Workbench | DigitalOcean

    Note: I haven’t followed these instructions. YMMV.