Boxafe Quick Start Guide

Boxafe is a NAS-based backup solution for cloud services such as Google Workspace and Microsoft 365. You can use Boxafe to back up cloud data from supported cloud services manually or automatically by schedule. Boxafe also supports backing up multiple versions of data. You can view and search your backed-up cloud data in Boxafe, and if needed, restore data to cloud services. If you have a large administrative/IT team in your organization, you can delegate Boxafe tasks, such as recurring cloud data backups, to other team members by utilizing custom Boxafe users and user roles. Boxafe is ideal for medium to large-sized organizations that need to record or safeguard cloud data of many users.

Cloud services supported by Boxafe

Supported NAS operating systems:

• QTS 5.0.0 or later
• QuTS hero h5.0.0 or later

Before you start using Boxafe, perform the following steps:

1. Log onto your NAS as an administrator.
2. Install Boxafe.
   1. Open App Center.
   2. Click  to open the search bar.
   3. Enter "Boxafe".
   4. Under the Boxafe app icon, click Install.
      
3. Select a storage pool to install Boxafe and click OK.
4. Obtain authorization for Boxafe from your domains:
   1. How to obtain authorization from Google for using Boxafe for Google Workspace?
   2. How to get authentication credentials for adding a Microsoft 365 Domain to Boxafe?
5. Optional: Purchase and activate premium Boxafe licenses.
   For details, see the Configure Boxafe licenses section.
6. Open Boxafe.
   Boxafe opens in a new browser tab. If you open Boxafe via a URL, then you need to log in to Boxafe with your NAS user account.
   The Storage Path Configuration window opens.
7. For Storage path options, select an option.
   For details on configuring the storage path, see How do I set up or change the storage path in Boxafe 2.0 and later?
   
8. Click Apply.
9. To back up data from a domain, perform the following steps:
   1. Optional: Create Boxafe users. 
   2. Optional: Configure Boxafe roles.
   3. Add one or more domains.
   4. Assign Boxafe licenses to domain users.
   5. Assign Boxafe licenses to domain services.
   6. Back up domain data.
   See the sections below for details on each step.

A Boxafe user is a NAS user that has permission to perform Boxafe tasks. Creating Boxafe users allows Boxafe administrators to delegate Boxafe tasks to other NAS users. You can also create and assign roles to Boxafe users. Roles grant permissions that assigned users can perform in Boxafe.

Create Boxafe users

1. Open Boxafe.
2. Go to Settings > Users.
3. Click + Add User.
4. For Select user, select a NAS user.
5. For Select a role, select a Boxafe role. See Configure Boxafe user roles for details on Boxafe roles.
6. For Select domain, select a domain if needed. If a domain is selected, the user will have access to that domain and will not have access to other domains.
   Tip

   Users with the role Super Admin or Global Admin can access all domains in Boxafe.
7. Click Apply.

Configure Boxafe user roles

1. Open Boxafe.
2. Go to Settings > Roles.
3. Click + Create Role to create a new role or click  next an existing role to edit the role.
4. If creating a new role, specify a name for the role in the Role field.
5. Select one or more permissions.
6. Click Apply.
   The selected permissions are applied to the role.

To back up or restore the data of a domain, the domain must be first added to Boxafe. You can also add subdomains of a domain to Boxafe. 

Add domains to Boxafe

Before adding a domain, you must authorize Boxafe to access the domain. For details, see the steps in Before you start.

1. Open Boxafe.
2. Go to Domains.
3. Click + Add Domain.
   
4. Select Google Workspace or Microsoft 365.
   The Add Domain window appears.
5. Authorize the domain by performing the following steps:

   Domain Type	Steps
   Google Workspace	Specify the following fields: Domain admin email address: Email address of the Google Workspace administrator used when generating a service key in Before you start. Service key: Upload the private service key JSON file generated in Before You start. Click Authorize. Google authorizes Boxafe to use the domain and the Domain info tab opens.
   Microsoft 365	Specify the following fields: Microsoft 365 endpoint Certificate password: Boxafe will generate a certificate file that can be used later to re-authenticate your Microsoft 365 domain. You will need to provide this password and the certificate file when you re-authenticate your Microsoft 365 domain. Confirm certificate password Click Authorize. Log into your Microsoft 365 domain. Microsoft authorizes Boxafe to use the domain. Your browser downloads the generated certificate file. Boxafe opens the Domain info tab.

6. Verify that the Domain name and Admin email are correct.
   
7. For Domain services, select the domain services you want to back up.
8. For Add Users, select one of the following:
   • Auto: Automatically add all users of the domain to Boxafe.
   • Manual: Manually add users of the domain to Boxafe by clicking and then selecting users.
9. For Add Shared Drives (Google Workspace only), select one of the following:
   • Auto: Automatically add all shared drives of the domain to Boxafe.
   • Manual: Manually add shared drives of the domain to Boxafe by clicking  and then selecting shared drives.
10. For Add SharePoint Site (Microsoft 365 only), select one of the following:
    • Auto: Automatically add all SharePoint sites of the domain to Boxafe.
    • Manual: Manually add shared drives of the domain to Boxafe by clicking  and then selecting SharePoint sites.
11. For Add Microsoft Teams (Microsoft 365 only), select one of the following:
    • Auto: Automatically add all teams of the domain to Boxafe.
    • Manual: Manually add Teams of the domain to Boxafe by clicking  and then selecting Teams.
12. Click Next.
    The Backup Schedule tab opens.
13. Configure a backup schedule. For details on configuring backup schedules, see Configure backup schedules for domain data.
14. Click Add.
    The domain is added to Boxafe.

Add subdomains to Boxafe

After adding a domain to Boxafe, you can add the subdomains of the domain and back up and restore data of the subdomain in the same way as backing up and restoring data for a domain.

1. Open Boxafe.
2. Go to Domains.
3. Locate a domain and click  to select it. This will be the parent domain of the subdomain.
4. Click .
   The Add Subdomains window opens.
5. Click a subdomain to select it.
6. Click Add Subdomains.
   A confirmation window appears.
7. Click OK.
   The subdomain is added to Boxafe and appears on the Domains page under the parent domain. 

Manage domain users

1. Open Boxafe.
2. Go to Domains.
3. Locate the domain and click in the Action column.
   The Domain Settings page opens.
4. Go to the Users tab.
   The Users page appears. Here you can view domain users added to Boxafe, add additional domain users, delete domain users, export a list of domain users, assign Boxafe licenses to users, and more.

Backing up and restoring domain service data in Boxafe requires Boxafe licenses. There are free Boxafe licenses available allowing you to back up and restore domain service data without purchasing any premium Boxafe licenses. The free Boxafe licenses available are:

To back up domain data for additional users or services, premium Boxafe licenses are required. To use a premium Boxafe license, the license must be purchased, activated, and then assigned individually to domain users and services in Boxafe.

Purchase and activate Boxafe licenses

1. Go to the QNAP Software Store and purchase premium Boxafe licenses.
   To back up a Google Workspace domain, a Boxafe For Google Workspace license is required. To back up a Microsoft 365 domains, a Boxafe for Microsoft 365 license is required. For details on purchasing licenses, see "Licenses > Buying a license using QNAP ID" in the QTS User Guide or QuTS hero User Guide.
2. Activate the Boxafe licenses. For details, see "Licenses > License activation" in the QTS User Guide or QuTS hero User Guide..

Assign Boxafe licenses to domain users

Assigning a Boxafe license to a domain user allows you to back up and restore the following user data:

1. Open Boxafe.
2. Go to Domains.
3. Locate the domain and click in the Action column.
   The Domain Settings page opens.
4. Go to the Users tab.
5. Select one or more users.
6. Go to Actions > Licenses > Assign.
7. Select a license.
8. Click Select.
   The selected license is assigned to the selected users.

Assign Boxafe licenses to domain services

Assigning a Boxafe license to a domain service allows you to back up and restore data from the service. The following services are supported:

1. Open Boxafe.
2. Go to Domains.
3. Locate the domain and click in the Action column.
   The Domain Settings page opens.
4. Go to a service tab.
5. Select one or more items.
6. Go to Actions > Licenses > Assign.
7. Select a license.
8. Click Select.
   The selected license is assigned to the selected items.

백업할 사용자 또는 백업할 서비스를 선택하여 도메인 데이터를 자동으로 백업하거나 수동으로 백업할 수 있습니다.

선택한 사용자에 대해 도메인 데이터를 수동으로 백업합니다.

1. Boxafe를 엽니다.
2. 이동합니다도메인으로 이동합니다.
3. 도메인을 찾아을 클릭합니다. Action열에서.
   Domain Settings페이지가 열립니다.
4. 이동합니다사용자탭
5. 하나 이상의 사용자를 선택합니다.
6. 을 클릭합니다.
   Backup창이 나타납니다.
   
7. 서비스서비스선택합니다서비스를 선택합니다그리고 백업할 도메인 서비스를 선택합니다.
8. Backup을 클릭합니다.
   Boxafe는 선택한 서비스와 사용자를 위한 백업 작업을 생성합니다. Tasks에서 백업 작업을 볼 수 있습니다.

선택한 서비스에 대해 도메인 데이터를 수동으로 백업합니다.

1. Boxafe를 엽니다.
2. 이동합니다도메인으로 이동합니다.
3. 도메인을 찾아을 클릭합니다. Action열에서.
   Domain Settings페이지가 열립니다.
4. 백업할 서비스의 탭으로 이동합니다. 예를 들어, 공유 드라이브를 백업하려면Shared Drives탭으로 이동합니다.
   
5. 하나 이상의 서비스를 선택합니다.
6. 클릭합니다.
7. Click Backup.
   Boxafe는 선택한 도메인 서비스에 대한 백업 작업을 생성합니다. Tasks에서 백업 작업을 볼 수 있습니다.

도메인 데이터에 대한 백업 일정을 구성합니다.

전체 도메인에 대한 단일 백업 일정을 구성하거나 각 도메인 서비스에 대한 개별 일정을 구성할 수 있습니다.

도메인에 대한 백업 일정을 구성합니다.

1. Boxafe를 엽니다.
2. 이동합니다.도메인.
3. 도메인을 찾고 클릭합니다.에서작업열.
4. 이동합니다.백업 일정탭.
5. 에 대해다음을 위한 백업 일정 정책 정의을 선택합니다.모든 애플리케이션.
6. 에 대해백업 유형을 선택합니다.예약됨.
7. 나머지 설정을 지정합니다.
8. 클릭합니다.업데이트.
9. 선택 사항: 예약된 백업에서 사용자를 제외합니다.
   1. 이동합니다.사용자.
   2. 사용자를 찾습니다.
   3. Enable Backup열에서, 예약된 백업에 포함되지 않기를 원하는 사용자의 도메인 서비스를 비활성화합니다.
      
10. 선택 사항: 예약된 백업에서 도메인 서비스를 제외합니다.
    1. 백업하려는 서비스의 탭으로 이동합니다. 예를 들어,공유 드라이브탭.
    2. 서비스를 찾습니다.
    3. Enable Backup열에서, 예약된 백업에서 서비스를 제외하려면 토글을 비활성화합니다.
       

도메인 서비스에 대한 개별 백업 일정을 구성합니다.

1. Boxafe를 엽니다.
2. 이동합니다.도메인.
3. 도메인을 찾고 클릭합니다.에서작업열.
4. 이동합니다.백업 일정탭.
5. 다음을 위한 백업 일정 정책 정의에 대해, 개별 애플리케이션을 선택합니다.
   확인 창이 나타납니다.
6. 클릭합니다.확인.
7. 백업하려는 서비스의 탭으로 이동합니다.
8. 백업 유형에 대해, 예약됨을 선택합니다.
   
9. 나머지 설정을 지정합니다.
10. 클릭합니다.업데이트.

Boxafe에 백업된 도메인 데이터는 볼 수 있고, 복원 및 내보낼 수 있습니다.

백업된 도메인 데이터를 봅니다.

1. Boxafe를 엽니다.
2. 이동합니다.도메인.
3. 도메인 이름을 클릭합니다.
4. 서비스 탭 중 하나로 이동합니다.
5. 오른쪽 상단 모서리에서 항목을 선택합니다.
   백업된 서비스 데이터가 표시됩니다. 다른 서비스는 데이터를 다르게 표시하고 다른 사용자 작업을 제공합니다.
   

백업된 도메인 데이터를 복원합니다.

1. Boxafe를 엽니다.
2. 이동합니다.도메인.
3. 도메인 이름을 클릭합니다.
4. 서비스 탭 중 하나로 이동합니다.
5. 오른쪽 상단 모서리에서 항목을 선택합니다.
6. 에 대해버전을 선택하여 백업 버전을 선택합니다.
7. 하나 이상의 항목을 선택합니다.
8. Actions > Restore로 이동합니다.
   Restore창이 열립니다.
9. 복원 설정을 지정합니다.
10. Restore를 클릭합니다.
    Boxafe가 선택한 데이터를 복원하는 작업을 생성합니다.

백업된 도메인 데이터 내보내기

1. Boxafe를 엽니다.
2. 이동합니다도메인.
3. 도메인 이름을 클릭합니다.
4. 서비스 탭 중 하나로 이동합니다.
5. 상단 오른쪽 모서리에서 항목을 선택합니다.
6. 에 대해버전백업 버전을 선택합니다.
7. 하나 이상의 항목을 선택합니다.
8. Actions > Export로 이동합니다.
   Export창이 열립니다.
9. 에 대해내보내기다음 옵션 중 하나를 선택합니다:
   • NAS (Boxafe가 호스팅되는 곳): Boxafe가 지정된 위치에 내보낸 데이터를 저장합니다.내보내기 경로.
   • 로컬 컴퓨터로 다운로드: 브라우저가 내보낸 데이터를 다운로드합니다.
10. 남은 내보내기 설정을 지정합니다.
11. Export를 클릭합니다.
    확인 창이 열립니다.
12. Continue를 클릭합니다.
    Boxafe가 선택한 데이터를 내보냅니다.

Boxafe는 데이터 백업과 같은 장기 실행 작업을 수행하기 위해 작업을 생성합니다. 작업은 다음에서 관리할 수 있습니다.작업.

작업에는 세 가지 유형이 있습니다:

• 실행 중인 작업: Boxafe가 현재 수행 중인 작업
• 예약된 작업: Boxafe가 곧 수행할 작업
• 완료된 작업: Boxafe가 최근에 완료한 작업

실행 중인 작업 중지

1. Boxafe를 엽니다.
2. 이동합니다작업.
3. 로 이동합니다실행 중인 작업탭.
4. 작업을 찾은 다음을 클릭합니다.
   확인 창이 나타납니다.
   
5. 클릭예.

작업의 하위 작업 보기

백업/복구작업이 생성되면 각 도메인 서비스에 대한 하위 작업이 생성되어 작업을 수행합니다. 작업의 하위 작업 상태를 확인하고 실패한 하위 작업을 다시 시도할 수 있습니다.

1. Boxafe 열기.
2. 이동작업.
3. 이동실행 중인 작업  또는완료된 작업탭.
4. 작업을 찾은 다음을 클릭합니다.
   자세한 작업 상태창이 나타납니다.
5. 하위 작업탭으로 이동합니다.
   

• Boxafe: Boxafe에 대한 QNAP 제품 페이지
• 지식 베이스: 검색 가능한 FAQ, 튜토리얼 및웹 도움말
• QNAP 대학: 지침용 비디오 자습서
• QTS 사용 설명서: 최신 QTS 버전용웹 도움말
• QuTS hero 사용 설명서: 최신QuTS hero버전용웹 도움말