Repository files navigation

Totally not an Imgur clone

I couldn't really find any open source project that allowed you to easily host images. So I decided to create one.

It feels like a hybrid between Imgur and Pastebin.

Right now this software is still in beta, and many things are still missing, or will be changed in the future.But it does function, so feel free to give it a try.

You can view a live demo here:https://picsur.org/

The images are deleted every five minutes, and the maximum filesize is 16MB. But it should give you an indication of how it works.

Here is a list of done features, and what is planned.For a more detailed list, you can always visitthe project.

Every featured marked here should work in the latest release.

• Uploading and viewing images

• Anonymous uploads

• User accounts

• User roles and permissions

• Proper CORS restrictions

• Exif stripping

• Ability to keep original

• Support for many formats

  • QOI
  • JPG
  • PNG
  • WEBP (animated supported)
  • TIFF
  • HEIF
  • BMP
  • GIF (animated supported)
  • JPG-XL
  • JPG-2000

• Convert images

• Edit images

  • Resize
  • Rotate
  • Flip
  • Strip transparency
  • Negative
  • Greyscale

• Deletable images

• Proper DB migrations

• Show own images in list

• Correct previews on chats

• Expiring images

• ShareX endpoint

• ARM64 and AMD64 Docker image

• White mode

• Public gallery

• Albums

If you encounter any bugs or oddities, please open an issuehere. Cause without feedback I'll never know they exists.

If you like this project, don't forget to give it a star. It tells me that I'm not wasting my time on something that people don't like.

Yes it still is. If I were to stop maintaining it, I would archive the repository.

However I do not have a lot of time on my hands, so updates are not always as frequent as I would like them to be.

The public instance is only a demo, and therefore only keeps images for 5 minutes. This is to prevent the server from running out of disk space, and to prevent people from using it to host questionable images.

If you wish to keep your images, you will have to host your own instance.

By default, users can't register their own accounts. This is to prevent users from accidentally allowing anyone to upload to their instance.

If you want to allow this you can though. To change this you go tosettings -> roles -> guest -> edit, and then give the guest role theRegister permission. Upon saving the role, the register button will appear on the login page.

By default, Picsur will not keep your original image files. Since for most purposes this is not needed, and it saves disk space.

If you want to enable this however, you can do so by going tosettings -> general, and then enabling theKeep original option. Upon saving the settings, the original files will be kept.

Do keep in mind here, that the exif data will NOT be removed from the original image. So make sure you do not accidentally share sensitive data.

QOI is a new lossless image format that is designed to be very fast to encode and decode. All while still offering good compression ratios. This is the primary format the server will store images in when uploaded.

You canread more about QOI here.

The default username isadmin, and the default password is set from thePICSUR_ADMIN_PASSWORD environment variable.

It is only possible to use the clipboard functionality on HTTPS websites or localhost. Please ensure you are running Picsur with HTTPS.

You easily run this service yourself via Docker. Here is an example docker-compose file:

version:'3'services:picsur:image:ghcr.io/caramelfur/picsur:latestcontainer_name:picsurports:      -'8080:8080'environment:# PICSUR_HOST: '0.0.0.0'# PICSUR_PORT: 8080PICSUR_DB_HOST:picsur_postgres# PICSUR_DB_PORT: 5432# PICSUR_DB_USERNAME: picsur# PICSUR_DB_PASSWORD: picsur# PICSUR_DB_DATABASE: picsur## The default username is admin, this is not modifiable# PICSUR_ADMIN_PASSWORD: picsur## Optional, random secret will be generated if not set# PICSUR_JWT_SECRET: CHANGE_ME# PICSUR_JWT_EXPIRY: 7d## Maximum accepted size for uploads in bytes# PICSUR_MAX_FILE_SIZE: 128000000## No need to touch this, unless you use a custom frontend# PICSUR_STATIC_FRONTEND_ROOT: "/picsur/frontend/dist"## Warning: Verbose mode might log sensitive data# PICSUR_VERBOSE: "true"restart:unless-stoppedpicsur_postgres:image:postgres:17-alpinecontainer_name:picsur_postgresenvironment:POSTGRES_DB:picsurPOSTGRES_PASSWORD:picsurPOSTGRES_USER:picsurrestart:unless-stoppedvolumes:      -picsur-data:/var/lib/postgresql/datavolumes:picsur-data:

• @aldumil for once donating $5
• @mcmastererp for monthly donating $2 from March 2024 to Oktober 2024
• @gander for monthly donating $5 from March 2024 to November 2024
• @TheSameCat2 for monthly donating $5 from November 2023 to May 2024
• @LordCrashWire for once donating $20
• @chennin for monthly donating $4 from June 2023 to September 2024
• @awg13 for once donating $10

Here is a usually up to date documentation of the api:

If you wish to build your own frontend or app for picsur, this will surely come in handy. Also take a look at the./shared folder in the source code, as it contains typescript schema definitions for the api.