Skip to content

Deploying

Jump to bottom
Arief Rachmawan edited this page Sep 10, 2023 · 4 revisions

Deploying to Vercel

This documentation will walk you through the steps to deploy this project on vercel.

Steps

  1. Create Google Cloud project and enable the Google Drive API
  2. Create service account
  3. Create shared folder for service account
  4. Configuring the project
  5. Configuring .env
  6. Deploying

Create a Google Cloud project and enable the Google Drive API

To create a Google Cloud project, follow these steps:

Create service account

To create service account, follow these steps:

  • Go to the Credentials menu on APIs & Services
  • Click Create Credentials button then Service account.
  • Enter service account name and description, and click Done button.
  • Open the service account you created, then go to Keys tab.
  • Click Add key button then Create new key, and choose JSON then create.
  • Go to base64 encode (https://www.base64encode.org), then encode the content of the JSON (make sure there are no extra space on the end)
  • Save this encoded base64 auth, we will use this later.

Create shared folder for service account

Shared account are used so we can add share permission to the service account, and also make the search only limited to that folder.

  • Go to you Google Drive
  • Create new folder, you can name it whatever you like.
  • Right click the folder, then click share.
  • Add service account email from the JSON files to the people with access, and change the General access to Anyone with the link as viewer.
  • Copy the link and take the folder ID. (https://drive.google.com/drive/folders/[id]?usp=sharing)

Configuring the project

Fork this project if you haven't, then open /config/gIndex.config.ts. Every config have it's own description, but make sure you change the rootFolder with the folder ID you create before.

Configuring .env

In the root folder there are .env.example, you can copy it and name it to .env.local or .env and change the value. There are only 4 keys inside of .env file:

  • GD_SERVICE_B64: Encoded base64 that we get from before
  • NEXT_PUBLIC_ENCRYPTION_KEY: 16 characters key that will be used to encrypt the folder / file password.
    • If it's empty it will use next-drive-index instead.
    • If it's under 16 characters long, it will add 0 until it's 16 characters.
    • If it's more than 16 characters long, it will cut the key to 16 characters.
  • NEXT_PUBLIC_SITE_PASSWORD: The password that will be used if you set private index to true in config files.
  • NEXT_PUBLIC_VERCEL_URL: WILL BE USED FOR DEV PURPOSE ONLY. Vercel will set this to the project url automatically, so there no need to add this to vercel deployment.

Deploying

Vercel

  • Open your vercel dashboard
  • Click add new > project button
  • Select the repository you fork
  • On the Environment Variables section, insert all .env content there (you can copy the content and then paste it to automatically populate the .env)
  • Deploy and enjoy.

Another service

For another service, you can check their own documentation for how to deploy a project. And also, make sure to match fileSizeLimit to your the service limit in gIndex.config.ts

Clone this wiki locally