Skip to content

Latest commit

 

History

History
68 lines (57 loc) · 3.42 KB

operator.md

File metadata and controls

68 lines (57 loc) · 3.42 KB
Raw

Operating Convene

Deploying Convene

A convene Neighborhood will eventually be deployable in several ways. Currently, we support deploying to:

  • Heroku via:
    • GitHub

Each of these methods is discussed in detail below:

Deploying to Heroku

GitHub

Deploying from GitHub is perhaps arguably the easiest way to deploy to Heroku, as it can be done entirely using their GUIs through Heroku-GitHub integration.
An overview is discussed below, but please see the GitHub Integration page on Heroku's site for details.

Steps:

  1. Make sure you have both GitHub and Heroku accounts.
  2. In GitHub, Fork the convene repo.
  3. Inside Heroku:
    1. Make a new pipeline
      1. Give the pipeline a unique name
      2. Click "Connect to GitHub" button, and follow instructions to connect
        1. If you have previously connected with GitHub, you should be able to search and select the repo
      3. Search for and select the appropriate repo (the fork of convene)
      4. Click "Create Pipeline"
    2. In new pipeline's "Pipeline" tab, click "Add App" then "Create new app..."
      1. Give another unique name
      2. Create
    3. In the new app's "Deploy" tab and enable automatic deploys
    4. Go to the app's "Settings" tab:
      1. Click "Add buildpack", select nodejs, then click "Save changes"
      2. Click "Add buildpack", select ruby, then click "Save changes"
      3. (These are already specified in the app.json file, but this wasn't working during testing.)
    5. You should be able to deploy by either:
      1. pushing to your "main" branch and have it automatically deploy or
      2. go to the app's "Deploy" tab and click the "Deploy Branch" button at the bottom of the page.

If you run into issues with this process that are not resolved with a bit of research, please do not hesitate to contact us!

Adding a new Space

Information you'll need:

  • email address(es) of the initial Space Member(s)
  • name of the Space (this will be converted to a slug)
  • if they will be using a branded domain, what is the name of the domain?

Once you have this information:

  1. Logged into your Convene operator account, go to the root of your Convene neighborhood (e.g.https://neighborhood.zinc.coop/)
  2. Click on "Add a Space", enter the space name and hit "Create". The name will be slugified to create the slug for the Space.
  3. Click on the gear to the left of the space name on the top left, to go to the Space configuration page.
  4. Go to "Invitations", and add invite the initial Space Members to the Space
  5. If the Space wants a branded domain:
    • Add the domain to the Heroku "Domains" configuration, under Settings > Domains. This will give you a DNS target, which you can give back to the client to configure their DNS to point their custom domain to your Convene Neighborhood.
    • Add the domain to the Space via the Rails console:
$ heroku run rails c -a <YOUR CONVENE DEPLOYMENT NAME>
[...]
irb(main):005:0> space = Space.find_by(slug: "THE-SPACE_SLUG")
irb(main):005:0> space.update!(branded_domain: "THE_DOMAIN.NET")