Repository files navigation

Microbox (aka µbox, mu-box, or mi-box, depending on who you talk to) is an open-source clone of Nanobox, focusing initially on feature-parity with Nanobox v1(boxfiles), then on adding features and maintaining the boxfile approach movingforward. Doing this will require making some changes to some of the tooling andDocker images used, for example to switch package managers to something thatwill take less time to maintain when new package versions are released. Moreinformation on this process will be added to the project documentation (checkthedocs/ directory) as it gets fleshed out.

For now, just getting the basic Nanobox features implemented will go a long wayin getting the project up and running.

• Dashboard
  • Accounts
    • Registration
    • Login
    • Social Login
    • 2FA *
    • Settings Management
      • Connected Social Accounts *
      • Hosting Accounts (#4)
      • Teams (#3)
        • Membership (#3)
        • Apps (#5)
        • Permissions *
      • Plans and Billing
  • Apps
    • Create (#5)
    • Manage
      • Servers (#5)
        • Reboot
        • Console
      • Components (#5,#8)
        • Restart
        • Rebuild
        • Move (#6)
        • Console
      • Ownership
      • Settings
      • Evars (#9)
      • SSL (#9)
    • Monitor
      • Logs
      • Stats
    • Deploy (#8)
    • Migrate *
    • Scale (#6)
    • Destroy (#7)
• Hosting Provider API (#4,#5,#6,#7,#9)
• MicroAgent API (#5,#6,#7)
• DNS API (shaman) (#5,#6,#7)
• CLI API (#8)
• Platform Component APIs (#5,#9)
  • Portal (load balancer)
  • Pulse (monitor)
  • Hoarder (warehouse)
  • Mist (message bus)
  • LogVac (logger)

* Itemsin italics are not supported by Nanobox, but are seen as essential toan initial release, for ensuring the most buy-in from folks looking for Nanoboxalternatives.

If you're setting up Microbox Core in your own development environment, theeasiest (and only supported) way to do it is with the Microbox CLI. Setting thatup is beyond the scope of this document, but once it's in place, you only needto do a couple of things to get started.

In the directory where you've cloned the Core's code:

microbox dns addlocal microbox.localmicrobox run node-start mix phx.server

And you should be off and running!

The section below outlines what Microbox uses. Folks installing and runningtheir own copies are free to use whatever works best for them.

• microbox is the canonical domain, withmubox,mibox,mu-box, andmi-box redirecting back to it (getµbox too, if the two-scripts thingcan be worked out/around)
• xn-box-wyc is for staging and testing before deploying tomicrobox (froman intentional typo ofxn--box-wyc, the punycode ofµbox, which we can'tactually register because it's a mixed-script name)

• .co/.com/.io/.space/.site/.website redirect to.cloud
• .rocks for community things

• microbox.cloud for onboarding (explain, register, etc)
• dashboard.microbox.cloud for the account and app management dashboard
• api.microbox.cloud for the API documented indocs/core-api.yaml
• ...

• :guid.:user.microbox.dev for exposing local dev instances to theInternet (not currently supported by Nanobox)
• :app.:user.microbox.app for apps
• :instance.:app.:team.microbox.team for team apps
• :app.:team.microbox.live for HA, A/B, etc

Giacomo Trezzi (@G3z)