Account Management

How to Sign Up for an Account

Create an account using the following command.

gigalixir signup

It will prompt you for your email address and password. You will have to confirm your email before continuing.

Gigalixir’s free tier does not require a credit card, but you will be limited to 1 instance with 0.2GB of memory and 1 postgresql database limited to 10,000 rows.

If you wish to signup with your Google account, you can use:

gigalixir signup:google

How to Upgrade an Account

Important
Tiers are applicable at the account level, not at the app or database level. Therefore, a Free Tier account can not have a payable set of apps or databases, nor can a Standard Tier account have a free set of apps.

The standard tier offers much more than the free tier, see Tiers.

The easiest way to upgrade is through the web interface at https://console.gigalixir.com/

To upgrade with the CLI:

gigalixir account:upgrade

NOTE
If you are running a version of the CLI before 1.10, you will need to first set a payment method with

gigalixir account:payment_method:set

How to Stop Billing / Cancel

Gigalixir uses usage-based billing. There is no “cancel plan” button because you are only billed for running apps and databases. To stop all charges:

  1. List your apps: 
    gigalixir apps
  2. For each app, scale down replicas: 
    gigalixir ps:scale -r 0 -a $APP_NAME
  3. Remove custom domains from each app: 
    gigalixir domains -a $APP_NAME
gigalixir domains:remove -a $APP_NAME $FQDN
  4. Destroy databases for each app: 
    gigalixir pg -a $APP_NAME
gigalixir pg:destroy -a $APP_NAME -d $DATABASE_ID
  5. Destroy each app: 
    gigalixir apps:destroy -a $APP_NAME

Once all apps and databases are destroyed, no new charges will accrue. Your account can remain open at zero cost.

Important
If you are on the Standard tier, you will receive one final invoice for usage up to the point of destruction. This final bill must be settled. After that, no further charges will be incurred.

How to Downgrade to the Free Tier

There is no self-service downgrade command. To downgrade from the Standard tier to the Free tier, you must first meet the free tier requirements:

  • No more than 1 app with no more than 1 replica at size 0.5 or smaller
  • No more than 1 free tier database (no standard tier databases)
  • No collaborators on your app

Once you meet these criteria, contact support to request a downgrade.

How to Delete an Account

Before deleting your account, you must first destroy all apps and databases. See How to Stop Billing above.

To completely destroy your account, run:

gigalixir account:destroy

If you no longer have the CLI installed or are unable to run these commands, contact support for assistance with account deletion.

How to Update your Payment Method

With the web interface, visit : https://console.gigalixir.com/#/account/payment-method and click on the edit button.

With the CLI, run

gigalixir account:payment_method:set

How to Change your Email Address

gigalixir account:email:set

You will be sent a confirmation email with a link to confirm the email change. The current email address will be sent an email with a link to revoke the change.

How to Change or Reset Your Password

With the web interface, visit https://console.gigalixir.com/#/password/reset

With the CLI, run

gigalixir account:password:change

If you forgot your password, send a reset token to your email address by running the following command and following the instructions in the email.

gigalixir account:password:reset

How to Resend the Confirmation Email

With the web interface, visit https://console.gigalixir.com/#/confirmation/resend

With the CLI, run

gigalixir account:confirmation:resend

How to Reset your API Key

If you lost your API key or it has been stolen, you can reset it by running

gigalixir account:api_key:reset

Your old API key will no longer work and you may have to login again.

How to Log Out

gigalixir logout

How to Log In

gigalixir login

This modifies your ~/.netrc file so that future API requests will be authenticated. API keys never expire, but can be revoked.

If you wish to login with your Google account, you can use:

gigalixir login:google

How to use Multi-Factor Authentication

MFA, also known as 2-factor authentication or 2FA, this gives your account an extra layer of security so someone with just your password still won’t be able to login to your account.

To activate MFA with the CLI, first make sure you have version 1.2 or higher.

To upgrade your CLI. See How to Upgrade the CLI.

Then run:

gigalixir account:mfa:activate

This logs you out, so re-login:

gigalixir login

Also, try it out on the web console: https://console.gigalixir.com/#/login

To deactivate, run:

gigalixir account:mfa:deactivate

To regenerate recovery codes, run

gigalixir account:mfa:recovery_codes:regenerate

How to Check Account Status

To check and verify account items - like what account you’re logged in as currently, what tier you are on, or how many credits you have available - simply run:

gigalixir account

What’s Next?