strapi-provider-upload-github-api v1.0.1

strapi-provider-upload-github-api

Github API provider for Strapi CMS file upload.

Prerequisite

• Max upload file size is 100MB but smaller 50MB is recommended. See Conditions for large files
• Enable Git LFS for your respository if planning to store large files. See Versioning large files
• Use GitHub page or vercel, surge, netlify for publishing.

Installation

npm install strapi-provider-upload-github-api

Configurations

./config/plugins.js

module.exports = ({ env }) => ({
  upload: {
    provider: 'github-api',
    providerOptions: {
      repo: env('GITHUB_UPLOAD_REPO'),
      user: env('GITHUB_UPLOAD_USER'),
      token: env('GITHUB_UPLOAD_TOKEN'),
      publicUrl: env('GITHUB_UPLOAD_PUBLIC_URL')
    }
  },
});

.env

GITHUB_UPLOAD_REPO=uploads
GITHUB_UPLOAD_USER=user-name
GITHUB_UPLOAD_TOKEN=***
GITHUB_UPLOAD_PUBLIC_URL=https://user-name.github.io/uploads

Parameters

• repo - github repository name
• user - github user name
• token - github user token (Creating a personal access token - GitHub Docs)
• publicUrl - the publishing url without slash (/) at the end.