ggtrd/share repository overview

⁠Features

• Securely send:
  • Passwords
  • Rich text
  • Code snippets
  • Large files (to bypass email provider attachments size limitation)
• Send simple one-clicks links to your recipient (basic links and passwords supported too)
• Automatic self-destruction
• Automatic strong password generation
• Fully customizable (logo and colors)
• Responsive interface
• No account required
• Self-hosted solution
• CLI available for administrative tasks
• Share passwords are protected using OpenPGP encryption (GopenPGP⁠ & OpenPGP.js⁠)

Tips
➡️ Share integrates seamlessly with reverse proxy authentication. For example, you can allow internal-only share creation while keeping unlock pages publicly accessible. See the example below⁠.

⁠Install from sources

• Install sources

  git clone [email protected]:ggtrd/share.git \
  && cd share \
  && go mod tidy \
  && go build
  

  Copy
• Initialize database

  ./share init
  

  Copy
• Start

  ./share web
  

  Copy

⁠Install with Docker

• Get docker-compose.yml

  curl -O https://raw.githubusercontent.com/ggtrd/share/refs/heads/main/docker-compose.yml
  

  Copy
• Get .env

  curl https://raw.githubusercontent.com/ggtrd/share/refs/heads/main/.env.example -o .env
  

  Copy
• Fill .env according to your needs
• Start

  docker compose up -d
  

  Copy

⁠Use the CLI

./share help

⁠Customization

⁠Logo

• Drop an image at /static/custom/logo.png or /static/custom/logo.svg
• (optional) drop a darkmode image at /static/custom/logo-darkmode.png or /static/custom/logo-darkmode.svg
• Overwrite logo size

:root {
    --logo-height: 60px;
}

⁠Color

• Overwrite color

  A color theme will be automatically calculated from this color

:root {
    --color: #4cd137;
}

⁠Advanced

⁠Instance details

Details (such as version) are available at URL/about

⁠Reverse proxy example

sudo a2enmod ssl proxy proxy_http

/etc/apache2/sites-available/001-share.conf

ServerName share.<domain>

<VirtualHost *:80>
        Redirect permanent / https://share.<domain>
</VirtualHost>

<VirtualHost *:443>
	SSLEngine on
	SSLCertificateFile      /etc/ssl/certs/<cert>.pem
	SSLCertificateKeyFile   /etc/ssl/private/<cert>.key

	# Allow everyone to get /share (= unlock share page)
	<Location "/share">
		AuthType none
		Satisfy any
	</Location>

	# Allow everyone to get /static (= style, images and JS files)
	<Location "/static">
		AuthType none
		Satisfy any
	</Location>

	# Require an authentication for everything else like /secret and /files (= create shares)
	# The authentication can be anything (basic auth, OIDC etc...)
	<Location "/">
		AuthType Basic
		AuthUserFile /etc/apache2/.htpasswd
		Require valid-user
	</Location>

	ProxyPreserveHost On
	ProxyRequests On
	ProxyPass / http://0.0.0.0:8080/
	ProxyPassReverse / http://0.0.0.0:8080/
</VirtualHost>

sudo a2ensite 001-share.conf

⁠Disclaimer

OpenPGP is used to cipher the password of a share when unlocking. It doesn't cipher anything else (like file download for example), please consider using HTTPS with a TLS certificate.

⁠License

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