Quick Start for Admins

If you haven’t already, start by installing the client.

Signing Up

If you haven’t already signed up, follow the instructions here to get signed up.

Accessing the Admin Panel

Mac:

  • Launch Ship and sign in
  • Click Ship → Administration … (⌘;)

iOS:

  • Launch Ship and sign in
  • Scroll to the bottom of the Overview
  • Tap Administration

Adding Users

  • Open the Admin Panel
  • Choose Users
  • Choose Create New
  • Fill out Name and Email of the new user

The new user will get an email with a sign up code and instructions on how to use it.

Removing Users

  • Open the Admin Panel
  • Choose Users
  • Choose Edit for the user to be removed
  • Select Inactive
  • Choose Save

Note

While you cannot actually delete users permanently, they may be marked as inactive. While inactive, a user cannot log in to Ship, and issues cannot be assigned to them.

Adding Milestones

  • Open the Admin Panel
  • Choose Milestones
  • Choose Create New
  • Give the new milestone a name
  • If the milestone is to be restricted to a certain component, select it here. Typically, this is left blank and the milestone is visible organization wide.
  • If you have a specific date range in mind, you may specify active dates. However, you can also leave this blank.

Closing Milestones

  • Open the Admin Panel
  • Choose Milestones
  • Choose Edit for the milestone to be closed
  • Set the end date of the active dates section to be a date in the past (e.g. yesterday).

Note

Users will be prevented from adding new problems to the closed milestone or moving existing problems to the closed milestone.

Adding Components

  • Open the Admin Panel
  • Choose Components
  • Choose Create New
  • Name the component

Note

Components are hierarchical and will appear in the UI as the concatenation of its name and its parent’s name (and grandparent’s name, etc). So if we add the component Client and set its parent to Ship, it will get the name in the UI Ship Client.

Closing Components

  • Open the Admin Panel
  • Choose Components
  • Choose Edit for the component to be closed
  • Select Closed
  • Choose Save

Note

Any problems in the closed component will remain there, but no new or existing problems will be assignable to the component anymore.

Configuring Slack Integration

Slack integration is provided to offer notifications to users of events within Ship such as problem assignments or watched problem changes.

  • Launch Slack
  • Click on your team name in the upper left of the Slack window
  • Choose Configure Integrations
  • Choose Bots to add a new Bot integration
  • Name the integration shipbot
  • Create the bot integration
  • Copy the API Token provided by slack
  • Launch Ship
  • Open the Admin Panel
  • Choose Slack
  • Paste the API Token in the Token field
  • Choose Save

Note

If a user’s email in Ship does not match their email in Slack, they may establish a correspondence between the two by launching the admin panel and configuring it under the Slack section.