Skip to content

Latest commit

 

History

History
81 lines (44 loc) · 4.02 KB

README-EN.md

File metadata and controls

81 lines (44 loc) · 4.02 KB
Raw

Telegraph-Image

Free Image Hosting solution, Flickr/imgur alternative. Using Cloudflare Pages and Telegraph.

English|中文

Use tg channel/chat for storage

How to use?

First, you need to create a new telegram bot to obtain the token and a telegram channel to obtain Chat_ID

How to Obtain Bot_Token and Chat_ID for Telegram

If you don't have a Telegram account yet, please create one first. Then, follow these steps to get the Bot_Token and Chat_ID:

  1. Get the Bot_Token

    • In Telegram, send the command /newbot to @BotFather, and follow the prompts to input your bot's name and username. Once successfully created, you will receive a Bot_Token, which is used to interact with the Telegram API.

  2. Set the bot as a channel administrator

    • Create a new channel and, after entering the channel, go to channel settings. Add the bot you just created as a channel administrator, so it can send messages.

  3. Get the Chat_ID

    • Use @GetTheirIDBot to get your channel ID. Send a message to this bot and follow the instructions to receive your Chat_ID (the ID of your channel).

Deployment

Preparation

The only thing you need to prepare in advance is a Cloudflare account

Step by Step Instruction

3 simple steps to deploy this project and have your own image hosting

1.Fork this repository (Note: In order to make this work. You have to using Git or Wrangler CLI to deploy this project. Document)

2.Open the Cloudflare Dashboard, enter the Pages management page, choose to create a project, then choose Connecting to the Git Provider

1

  1. Follow the prompts on the page to enter the project name, select the git repository you need to connect to, then click Deploy

Features

  1. Unlimited number of images stored, you can upload an unlimited number of images

  2. No need to buy a server, hosted on Cloudflare's network, when the use does not exceed Cloudflare's free quota, completely free

  3. No need to buy a domain name, you can use the free second-level domain name *.pages.dev provided by Cloudflare Pages, and also support binding custom domain names

  4. Support image review API, can be opened as needed, after opening undesirable images will be automatically blocked, no longer loaded

Add custom domains

Inside the custom domain of pages, bind the domain name that exists in your Cloudflare account, the domain name hosted in cloudflare, will automatically modify the dns record 2

Setup image review API

  1. Please go to https://moderatecontent.com/ to register and get a free API key for reviewing image content

  2. Open the settings of Cloudflare Pages, click Settings, Environment Variables, Add Environment Variables in turn

  3. Add a variable name as ModerateContentApiKey, value as the API key you just got in the first step, click Save to

Note: Since the changes will take effect on the next deployment, you may need to go to the Deploy page and redeploy the project

When image review is enabled, the first time image load will be slow because it takes time to review, but the subsequent image load will not be affected due to the existence of cache 3

Limitations

  1. Since the image files are actually stored in Telegraph, Telegraph limits the size of uploaded images to a maximum of 5MB

  2. Due to the use of Cloudflare's network, the loading speed of images may not be guaranteed in some areas.

  3. The free version of Cloudflare Function is limited to 100,000 requests per day (i.e. the total number of uploads or loads of images cannot exceed 100,000), if this is exceeded, you may need to choose to purchase the paid package of Cloudflare Function.

Thanks

Ideas and code provided by Hostloc @feixiang and @乌拉擦