Slink: Image Sharing Platform

Slink is a self-hosted image sharing platform built with Symfony and SvelteKit️.

Solves the problem of sharing images with friends, family, and colleagues without relying on third-party services. It also offers a platform for artists to share their work with the community. Additionally, developers may find it useful for self-hosting screenshots of personal projects, which can then be used on GitHub, portfolios, blogs, etc.

Features

• Image Upload: Supports PNG, JPG, WEBP, SVG, BMP, ICO, GIF, AVIF, HEIC* and TIFF*.
• Authentication: Users can sign up and log in to the platform.
• User Approval: Require user approval before they can upload images.
• Share Links: Users can share links to their uploaded images and customize the image size.
• Upload History: Provides an overview of all images uploaded by the user.
• Storage Providers: Support for local, SMB, AWS S3 storage providers.
• Explore Images: Features a listing page of public images uploaded by other users.
• Dark Mode: Includes support for both Dark and Light modes in the application.
• Dashboard: Enhanced statistics and analytics for admin users.
• Settings Configuration: Ability to manage users, storage, and other settings.
• Public API: A public API to access the platform programmatically (Still needs to be documented).

Note

HEIC and TIFF images are converted to JPG format before being saved for better compatibility.

Upcoming Features

Important

Those might be changed or removed in the future according to the community feedback and priorities.

• Multiple Image Upload: Allow users to upload multiple images at once.
• Tags: Allow users to tag their images for better organization and search.
• Collections: Users can create collections of images and share them with others.
• Password Protection: Allow users to protect their images with a password.
• Image Compression: Compress images to reduce the file size and improve performance.
• CDN Support: Support for CDN providers to reduce the load on the self-hosted server.
• Storage Providers: Extend the support for additional storage providers.
• Anonymous Upload: Allow users to upload images without signing up.
• Password Recovery: Password recovery for users who forgot their password.
• Email Notifications: Email notifications for user approval, password reset, etc.
• ShareX Integration: Provide a ShareX configuration file for easy integration with the platform.
• URL Shortening Integration: Integration with URL shortening services.
• (Optional) Database Support: Support for additional databases like MySQL, PostgreSQL, etc.
• (Optional) GPU acceleration: Use GPU acceleration for image processing to improve performance.
• (Experimental) Short Video Support: Allow users to upload short videos and perform basic editing.

Non-Functional planned improvements

• Testing: Comprehensive test coverage for the application.
• Responsive Design: Continuously improve the design for better mobile and tablet experience.
• Theming: Introduce more themes rather than just Dark and Light modes.

Installation

To install the application, you need to have Docker installed on your system.

Important

DO NOT forget to set the ORIGIN environment variable representing your hostname. Otherwise, the application might not work as expected. Make sure to replace https://your-domain.com with your actual domain.

Just run the following command to start the application:

docker run -d \
    --name slink \
    -p 3000:3000 \
    -v ./slink/var/data:/app/var/data \
    -v ./slink/images:/app/slink/images \
    -e ORIGIN=https://your-domain.com \
    anirdev/slink:latest

Docker Compose

You can also use Docker Compose to start the application.

slink:
  image: anirdev/slink:latest
  container_name: slink
  environment:
    # Your timezone
    - TZ=UTC
    
    # Your application hostname
    - ORIGIN=https://your-domain.com
    
    # Require user approval before they can upload images
    - USER_APPROVAL_REQUIRED=true
    
    # User password requirements
    - USER_PASSWORD_MIN_LENGTH=8
    - USER_PASSWORD_REQUIREMENTS=15 # bitmask of requirements 
    
    # Maximum image size allowed to be uploaded (no more than 50M)
    - IMAGE_MAX_SIZE=15M
    
    # Storage provider to use (may require additional configuration variables for different providers, see below)
    - STORAGE_PROVIDER=local
  volumes:
    # Persist the database
    - ./slink/var/data:/app/var/data
    # Persist the uploaded images
    - ./slink/images:/app/slink/images
  ports:
    # Expose the application on port 3000
    - "3000:3000"

Tip

If you are using Traefik, you don't need to expose the application on port 3000. You can use Traefik to route the traffic to the application by adding the corresponding labels to the service.

Configuration

The application can be configured using environment variables. Simply set the environment variables when starting the Docker container or in your docker-compose.yml when using Docker Compose.

The following environment variables are available:

Variable	Description	Default Value
USER_APPROVAL_REQUIRED	Whether to require user approval before they can upload images. Available options are true and false	true
USER_ALLOW_UNAUTHENTICATED_ACCESS	Whether to allow unauthenticated users to access public routes. Available options are true and false	true
USER_PASSWORD_MIN_LENGTH	Minimum password length required for users.	6
USER_PASSWORD_REQUIREMENTS	Bitmask of password requirements. Sum of the following options: 1 (numbers), 2 (lowercase), 4 (uppercase), 8 (special characters).	15
IMAGE_MAX_SIZE	Maximum image size allowed to be uploaded (no more than 50M).	15M
IMAGE_STRIP_EXIF_METADATA	Whether to strip EXIF metadata from the uploaded images. Available options are true and false	true
STORAGE_PROVIDER	Storage provider to use. Available options are local,smb,s3	local
SMB_HOST	SMB host to connect to. Required if Samba provider is used.	null
SMB_USERNAME	SMB username to use. Required if Samba provider is used.	null
SMB_PASSWORD	SMB password to use. Required if Samba provider is used.	null
SMB_SHARE	SMB share to use. Required if Samba provider is used.	null
AMAZON_S3_REGION	AWS region to use for S3 storage. Required if an Amazon S3 provider is used.	null
AMAZON_S3_BUCKET	AWS bucket name to use for S3 storage. Required if an Amazon S3 provider is used.	null
AMAZON_S3_ACCESS_KEY_ID	AWS access key ID to use for S3 storage. Required if an Amazon S3 provider is used.	null
AMAZON_S3_SECRET_ACCESS_KEY	AWS secret access key to use for S3 storage. Required if an Amazon S3 provider is used.	null

Public Image Listing

The application has an optional image listing page where users can explore images uploaded by other users.

Note

Only images marked as public will be visible here.

Storage Providers

The application supports two storage providers: local, SMB, and AWS S3. Local storage provider stores the images on the local filesystem, and it's selected by default when you spin up the application, unless you specify a different provider.

Important

To persist locally saved images, you need to mount the /app/slink/images directory to the host filesystem.

User Approval

By default, the application requires user approval before they can upload images. You can disable this feature by setting the USER_APPROVAL_REQUIRED environment variable to false.

If the user approval is enabled, you will have to activate the users manually with CLI command:

docker exec -it slink slink user:activate --email=<user-email>

or

docker exec -it slink slink user:activate --uuid=<user-id>

Newly registered users will be seeing the following message:

After the user is approved, they will be able to log in and upload images.

Note

Users can be also managed from the admin dashboard.

User Roles

Important

Available from version 1.3.0

The application has two user roles: User and Admin. By default, all users are assigned the User role.

To promote a user to the Admin role, you can use the following CLI command:

docker exec -it slink slink user:grant:role --email=<user-email> ROLE_ADMIN

To demote a user from the Admin role, you can use the following CLI command:

docker exec -it slink slink user:revoke:role --email=<user-email> ROLE_ADMIN

Alternatively, you can change the user role directly from the admin dashboard.

Note

Admin users have access to the admin dashboard and can manage users and settings. There is no granular permission system in place yet. If it becomes a requested feature, it will be added in the future.

Security

Slink supports user authentication and user approval to prevent unauthorized access to the application. However, it's recommended to use a reverse proxy like Nginx or Traefik to add additional security features like SSL, rate limiting, etc.

Warning

Be aware that as of now, the application does not have any built-in rate limiting or brute force protection.

Tip

If you don't want to expose the entire application to the public, you can only expose the /image route via the reverse proxy.

Overriding PHP Configuration

If you need to override the PHP configuration, you can do so by mounting a custom php.ini file to the /usr/local/etc/php/conf.d/ directory in the container.

Here is an example of how you can override the upload_max_filesize and post_max_size settings:

slink:
    # Your existing configuration
    volumes:
      # Your existing volumes
      
      # Overriding this file will allow to overcome the default 50M upload limit
      # Change the values according to your needs for both upload_max_filesize and post_max_size
      - ./custom-php.ini:/usr/local/etc/php/conf.d/uploads.ini

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. Any contributions you make are greatly appreciated, whether they are new features, bug fixes, or code quality improvements.

License

This project is licensed under the AGPLv3 License. See the LICENSE file for details.