Git Product home page Git Product logo

fipes's Introduction

Fipes, plumbings to share files

Fipes provides you a simple way to share files with your friends.

Goals

  • Provides a small web application.
  • Easy to install, easy to launch, easy to use.
  • Doesn't keep any data about you or your files.
  • Free as in freedom.

Getting Started

Requirements

  • Erlang (R14B04 or later)
  • Rebar (already in the repository)

Install the project

$ git clone https://github.com/tOkeshu/fipes.git
$ cd fipes
$ make app

These commands should pull the Erlang dependencies via Rebar and build a release.

Configure Nginx

Here is a sample configuration for nginx:

# /etc/nginx/sites-available/fipes.example.com
server {
    listen   80;

    root /path/to/fipes/public;
    index index.html index.htm;

    server_name fipes.example.com;
    server_name_in_redirect off;

    location / {
           proxy_pass http://127.0.0.1:3473/index.html;
    }

    location /fipes {
           proxy_pass http://127.0.0.1:3473/fipes;
    }

    location /static/ {
           proxy_pass http://127.0.0.1:3473/static/;
    }
}

Enable your site:

$ sudo ln -s /etc/nginx/sites-available/fipes.example.com /etc/nginx/sites-enabled/fipes.example.com
$ sudo /etc/init.d/nginx reload

Start the server

$ cd fipes
$ ./rel/fipes/bin/fipes start # start the server on port 3473

Then open a browser to http://fipes.example.com (where fipes.example.com is your domain).

If you just want to test the application on your machine, just edit your /etc/hosts:

# /etc/hosts
127.0.1.1	fipes.example.com

Bugs/Pitfalls

  • For now, Fipes can't be used without Nginx proxying the application on port 3473 (as shown in the sample file). Any other configuration will probably fail.

  • Reloading the page while you're in a Fipe will stops the browser from serving your files. This is normal as the JavaScript File objects are lost while refreshing the page. You'll have to offers these files again.

  • For now, anyone can enter a Fipe.

What about the name

Fipes is a Portmanteau word combined from the two words file and pipes. In other words, Fipes can be seen as a pipe for files.

License

Fipes is released under the terms of the GNU Affero General Public License v3 or later.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.