Skip to content
dc-bcgov edited this page Mar 24, 2023 · 29 revisions

Welcome to the BCBox Wiki [draft]

Table of Contents

General information

  • BCBox is for internal users, who need to share with external users, the BC Box is a Canadian website that allows low-cost, simple, publicly usable, and intractable storage with self-serve permission management.
  • Unlike Dropbox and major cloud storage providers, our product is compliant with government standards of data sovereignty.
    Unlike S3 Browser, our product is a website, appropriate for general users, and allows permissions settings for authenticated users.
  • Unlike Geodrive, our product does not require installation and allows public sharing.
  • Unlike SharePoint, our product’s storage cost is less, allows easier public sharing of files, and requires no administrative overhead.
  • Unlike many competitors, our product focuses on lowering the barrier of entry to immediately share files in a compliant manner.

User Manual

How to access/logout


Open any modern internet browser and type in the following URL production_link on the browser’s address bar. The log-in page will be displayed. To access the BCBox application, click on the Log in, the right hand side of the screen. To log out, click on the link to “Sign out” located at the upper right corner of the page.

Log in hand

Log-in Page


To log-in, click on the “IDIR“, “Basic BCeID“ or “Business BCeID“ button and enter the username and password.

login Login idir

My Buckets

Once logged in, the initial screen will be displayed, which shows the button “My Buckets”.

Clicking on the "My Buckets" will bring up a page with existing buckets or new buckets to be configured.

My buckets

Configure New Bucket


To add a new bucket click on "Configure new bucket". Once the button has been clicked, the dialog will be displayed, requiring you to fill in the bucket configuration information.

  • Bucket Name (mandatory) - your custom display name for the bucket.
  • Bucket (mandatory) - your storage provider's bucket identifier.
  • Endpoint (mandatory) - the URL of the object storage server.
  • Access key identifier / Username (mandatory) - user/account identifier or username.
  • Secret access key (mandatory) - a password used to access the bucket.
  • Key (optional) - an optional path prefix within a bucket. The path will be created if it doesn't already exist.
Configure bucket

Bucket Details


Bucket details view provides you with a general properties of the bucket – bucket name, bucket id and managed by.

Bucket details

Bucket Permissions


Permission model contains 5 discrete permission codes. Each of the codes represents a different set of permissions and actions that are allowed to be performed on the resource. For the most part, the permissions follow general CRUD principles and should be relatively self-explanatory.

PermCode Permission Description
CREATE Create Grants resource creation permission. Normally only the owner will have this permission assigned.
READ Read Grants resource read permission. Ignored when in public mode for only objects.
UPDATE Update Grants resource update permission. Allows user to upload a new version and/or edit metadata/tags for the object, or to edit bucket details.
DELETE Delete Grants resource deletion permission. Allows user to delete objects and versions.
MANAGE Manage Grants resource permission management. Allows the user to add/remove these permissions to other users.

The Bucket Permissions dialog allows the bucket administrator to manage bucket permissions - add or remove additional users/viewers to the bucket. To add an user click on the "Add user" button, search for an IDIR/BCeID user by typing in the user's email address. Select one from dropbox and click "Add".

Once the user added check/uncheck the "Read", "Update", "Delete", and/or "Manage" permissions checkboxes to add or remove bucket permissions to the added user.

To delete the users' permissions, click on the x-person icon. Only user-added permissions can be deleted. When deleting user-defined permissions, each of the permission will be deleted but not and the user itself.

Bucket permissions

My Files/Objects

Files

File Details

File details

Object Permissions

Object Permissions

File Upload

File upload - complete

File Sharing

File sharing