TempFiles Frontend

Share files securely over the internet for a day.

See more information about TempFiles here.

Installation

The following text describes how to install the static website (Frontend).
For instructions on how to install the Backend service responsible for the encryption and storage of uploaded files, see tempfiles-download/Backend.

JAMstack CDN (GitHub Pages / Cloudflare Pages)

TempFiles Frontend is primarily built to be hosted on CDNs as a static website.
It's therefore trivial to use GitHub Pages to host the website for free:

1. Fork this repository.
2. Edit the URLs in _config.yml to reflect your Backend server's address.
3. Select master as source branch and / (root) as source path on Settings > Pages
4. (Optionally) Create a CNAME file with your desired domain name and point your domain to <username>.github.io.

Docker

To run the frontend site for your own TempFiles instance using Docker, do the following:

1. Download docker-composer.json and _config.yml.
2. Edit the URLs in _config.yml to reflect your backend server's address.
3. (Optionally) change the repository value in _config.yml.
4. (Optionally) Open docker-compose.yml and forward port 4000 to your desired outgoing port.
5. Run docker-compose up -d.
6. The frontend should now be reachable on the outgoing port you selected in step 4. A reverse proxy is recommended for TLS.

Jekyll

Here's how to install and run the Frontend of TempFiles locally without Docker:

1. Download the code

   git clone https://github.com/tempfiles-download/Frontend.git Frontend
   cd $_

2. Install Ruby

   sudo snap install ruby --classic

3. Install the required Ruby gems 💎

   bundle install --path vendor/bundle

4. Run minification and cleanup scripts

   ./_scripts/*.sh

5. Build the site

   bundle exec jekyll build

6. Either:

7. Point your web server or reverse proxy server to the newly generated _site/ directory.

8. Set up a simple web server with:

   bundle exec jekyll serve

```

1. If you're going to use your own backend server, remember to change the URL values in _config.yml.

Contributing

See something missing in TempFiles? Contributions are appreciated!
Before doing changes to the code of TempFiles make sure you write in a program that complies with our EditorConfig.

You can also create a new issue.