strapi-provider-upload-github's Introduction

strapi-provider-upload-github

Github/Github-Pages provider for Strapi CMS file upload.

Installation

npm install strapi-provider-upload-github

Prerequisite

Make sure git is installed and accessable at runtime on server.
Avoid using code repo for uploading assets.
Given empty branch should not contain any files.

Config

./extensions/upload/config/config.json

{
      "provider": "github",
      "providerOptions": {
          "repo": "https://github.com/user-name/site-assets",
          "user": "user-name",
          "token": "***token***",
          "emptyBranch": "upload",
          "baseBranch": "master",
          "publicUrl": "https://user-name.github.io/site-assets",
          "sizeLimit": 1000000
      },
}

Parameters

repo - github repo link
user - github user name
token - github user token (Creating a personal access token - GitHub Docs)
emptyBranch - branch name with no files (Empty branch used to auto merge uploaded files without any conflicts).
baseBranch - branch name pointed to github pages.
publicUrl - github pages public url. (alternatively you can use public urls from vercel, surge, netlify)
sizeLimit - upload file size limit.

Resources

MIT License

Links

strapi-provider-upload-github's People

Stargazers

Watchers

strapi-provider-upload-github's Issues

Use Contents API to add a file

Hey, thanks for the plugin, it was a big in inspiration for me to try something similar.

I found the setup a bit complicated, why do we need an additional empty branch etc. Have you considered using Contents API to add files to the repository?

Contents API reference

I played with it and it looks promising:

const { Octokit } = require('@octokit/core')

octokit = new Octokit({
  auth: personalAccessToken
})

async upload(file) {
  // Find some unique file name for the uploaded file
  const filePath = generateUploadFileName('content/', file)

  const response = await octokit.request('PUT /repos/{owner}/{repo}/contents/{path}', {
    owner,
    repo,
    path: filePath,
    message: `Add ${filePath}`,
    content: file.buffer.toString('base64')
  })

  file.url = response.data.content.download_url
}