thegreatestgiant / onedrive-cf-index Goto Github PK

onedrive-cf-index

OneDrive indexing powered by CloudFlare Workers

1. Visit this URL to create a new Blade app: Microsoft Azure App registrations (normal version of OneDrive) or Microsoft Azure.cn App registrations (OneDrive 21Vianet version) :

   1. Log in with your Microsoft account, select New registration;
   2. Set the name of the Blade app at Name, such as my-onedrive-cf-index;
   3. Set Supported account types to Accounts in any organizational directory (Any Azure AD directory - Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox). OneDrive 21Vianet user set to: Account in any organizational directory (any Azure AD directory - multi-tenant);
   4. Set Redirect URI (optional) to Web (drop-down option box) and http://localhost (URL address);
   5. Click Register.

   

2. Get your Application (client) ID - client_id in the Overview panel:

   

3. Open the Certificates & secrets panel, click New client secret, create a new Client secret called client_secret, and set Expires to Never. Click Add and copy client_secret the Value and save it (only one chance):

   

4. Open the API permissions panel, select Microsoft Graph, select Delegated permissions, and search for the three permissions offline_access, Files.Read, Files.Read.All, select these three permissions, and Click Add permissions:

   

   You should successfully enable these three permissions:

   

5. Obtain refresh_token, and execute the following command on the local machine (need Node.js and npm environment, please refer to Preparation for installation and recommended configuration):

   npx @beetcb/ms-graph-cli

   

   Choose the appropriate option according to your own situation, and enter a series of token token configurations we obtained above, among which redirect_url can be directly set to http://localhost. For the specific usage of command line tools, please refer to: beetcb/ms-graph-cli.

6. Finally, create a public shared folder in our OneDrive, such as /Public. It is recommended not to share the root directory directly!

Finally, after all this tossing, we should have successfully obtained the following credentials:

• refresh_token
• client_id
• client_secret
• redirect_uri
• base: defaults to /Public.

Yes, I know it's troublesome, but this is Microsoft, please understand. 🤷🏼‍♂️

Fork and then clone or directly clone this warehouse, and install dependencies Node.js, npm and wrangler.

_It is strongly recommended that you use Node version manager such as n or nvm to install Node.js and npm, so that the wrangler we installed globally can install and save configuration files in our user directory, and we will not encounter strange permission problems. _

# Install CloudFlare Workers official compilation and deployment tool
npm install -g wrangler

# install dependencies using npm
npm install

# Login to CloudFlare account with wrangler
wrangler login

# Use this command to check your login status
wrangler whoami

Open https://dash.cloudflare.com/login, log in to CloudFlare, create a worker at Workers -> Manage Workers -> Create a Worker, and then look on the right side for your Accound ID.

Modify our wrangler.toml:

• name: is the name of the worker we just created, and our Worker will be published under this domain name by default: <name>.<worker_subdomain>.workers.dev;
• account_id: our Cloudflare Account ID;

Create a Cloudflare Workers KV bucket called BUCKET:

# create KV bucket
wrangler kv:namespace create "BUCKET"

# ... Alternatively, create a KV bucket that includes preview functionality
wrangler kv:namespace create "BUCKET" --preview

The preview function is only used for local testing, and has nothing to do with the image preview function on the page.

Modify kv_namespaces in wrangler.toml:

• kv_namespaces: our Cloudflare KV namespace, just replace id and/or preview_id. _If you don't need the preview function, just remove preview_id. _

Modify src/config/default.js:

• client_id: the OneDrive client_id just obtained;
• base: the previously created base directory;
• If you deploy the regular international version of OneDrive, then ignore the following steps;
• If you are deploying the China version of OneDrive operated by 21Vianet:
  • Modify accountType under type to 1;
  • keep driveType unchanged;
• If you are deploying a SharePoint service:
  • leave accountType unchanged;
  • Modify type under driveType to 1;
  • and modify hostName and sitePath according to your SharePoint service.

Use wrangler to add Cloudflare Workers environment variables (We can lock a specific folder (directory) and require authentication to access it. We can write the directories we want to make private folders into the ENABLE_PATHS list in the src/auth/config.js file. We can also customize the user name NAME and password used for authentication, where the authentication password is saved in the AUTH_PASSWORD environment variable, which needs to be set using wrangler):

# Add our refresh_token and client_secret
wrangler secret put REFRESH_TOKEN
# ... and paste our refresh_token here

wrangler secret put CLIENT_SECRET
# ... and paste our client_secret here

wrangler secret put AUTH_PASSWORD
# ... enter the authentication password we set here

Add Required Packages

npm install font-awesome-filetypes marked

We can then preview the deployment using wrangler:

wrangler dev

If all goes well, we can publish the Cloudflare Worker with the following command:

wrangler publish

We can also create a GitHub Actions to automatically publish a new Worker every time push to the GitHub repository, for details, refer to: main.yml.

If you want to deploy Cloudflare Worker under your own domain name, please refer to: How to Setup Cloudflare Workers on a Custom Domain.

• We should change the default "landing page", directly modify the HTML of intro in src/folderView.js;
• We also should change the header of the page, just modify src/render/htmlWrapper.js directly;
• The style CSS file is located at themes/spencer.css, you can customize this file according to your own needs, and you also need to update src/render/htmlWrapper.js commit HASH in the file;
• We can also customize Markdown rendering CSS style, PrismJS code highlighting style, etc.