PHP JavaScript CSS Nginx Makefile PLpgSQL
Clone or download

README.md

Pomf

Build Status Dependency Status devDependency Status MIT licensed Documentation Status

Pomf is a simple file uploading and sharing platform.

Features

  • One click uploading, no registration required
  • A minimal, modern web interface
  • Drag & drop supported
  • Upload API with multiple response choices
    • JSON
    • HTML
    • Text
    • CSV
  • Supports ShareX and other screenshot tools

Demo

See the real world example at sugoi.vidyagam.es.

Requirements

Original development environment is Nginx + PHP5.5 + MySQL, but is confirmed to work with Apache 2.4 and newer PHP versions. Should work with any other PDO-compatible database.

Install

For the purposes of this guide, we won't cover setting up Nginx, PHP, MySQL, Node, or NPM. So we'll just assume you already have them all running well.

Compiling

First you must get a copy of the pomf code. To do so, clone this git repo. You will need to recursively clone the repo to get the required PHP submodule, and the optional user panel submodule.

git clone --recursive https://github.com/pomf/pomf

If you don't want either of the submodules run the following command,

git clone https://github.com/pomf/pomf

Assuming you already have Node and NPM working, compilation is easy. If you would like any additional submodules, or to exclude the default PHP submodule, use the MODULES="..." variable.

Run the following commands to do so.

cd pomf/
make
# alternatively
make MODULES="" # compile no submodules; exclude the default php backend module
make MODULES="php moe" # compile the php and moe submodules
#
make install

OR

make install DESTDIR=/desired/path/for/site

After this, the pomf site is now compressed and set up inside dist/, or, if specified, DESTDIR.

Configuring

Front-end related settings, such as the name of the site, and maximum allowable file size, are found in dist.json. Changes made here will only take effect after rebuilding the site pages. This may be done by running make from the root of the site directory.

Back-end related settings, such as database configuration, and path for uploaded files, are found in static/php/includes/settings.inc.php. Changes made here take effect immediately.

If you intend to allow uploading files larger than 2 MB, you may also need to increase POST size limits in php.ini and webserver configuration. For PHP, modify upload_max_filesize and post_max_size values. The configuration option for nginx webserver is client_max_body_size.

Example nginx configs can be found in confs/.

Using SQLite as DB engine

We need to create the SQLite database before it may be used by pomf. Fortunately, this is incredibly simple.

First create a directory for the database, e.g. mkdir /var/db/pomf.
Then, create a new SQLite database from the schema, e.g. sqlite3 /var/db/pomf/pomf.sq3 -init /home/pomf/sqlite_schema.sql. Then, finally, ensure the permissions are correct, e.g.

chown nginx:nginx /var/db/pomf
chmod 0750 /var/db/pomf
chmod 0640 /var/db/pomf/pomf.sq3

Finally, edit php/includes/settings.inc.php to indicate this is the database engine you would like to use. Make the changes outlined below

define('POMF_DB_CONN', '[stuff]'); ---> define('POMF_DB_CONN', 'sqlite:/var/db/pomf/pomf.sq3');
define('POMF_DB_USER', '[stuff]'); ---> define('POMF_DB_USER', null);
define('POMF_DB_PASS', '[stuff]'); ---> define('POMF_DB_PASS', null);

NOTE: The directory where the SQLite database is stored, must be writable by the web server user

Apache

If you are running Apache and want to compress your output when serving files, add to your .htaccess file:

AddOutputFilterByType DEFLATE text/html text/plain text/css application/javascript application/x-javascript application/json

Remember to enable deflate_module and filter_module modules in your Apache configuration file.

Migrating from MySQL to SQLite

, Compared to SQLite, MySQL is relatively complicated to administer, brings in many unneeded dependencies, and consumes more resources. Additonally, as a network service, poorly configured installations have the potential to pose a security risk.

For these reasons, you may wish to use SQLite rather than MySQL.

Fortunately, it is incredibly simple to migrate your database. This may be done on a live server, if you desire, and requires zero downtime.

The process described below involves running these commands on a live server. Nothing done here affects your main site, until running the very last command, which is done after verifying there are no issues.

No changes described here are destructive, and are easily reverted. They only have the potential to cause uploading to fail gracefully, and will not affect downloading.

Run the following commands as root, to dump your database, and make a SQLite database with the contents.

mkdir /var/db/pomf
wget -O /tmp/m2s https://github.com/dumblob/mysql2sqlite/raw/master/mysql2sqlite.sh
mysqldump -u OLD_DB_USER -p OLD_DB_PASS pomf | sh /tmp/m2s | sqlite3 /var/db/pomf/sq3
rm /tmp/m2s
chown -R nginx:nginx /var/db/pomf #replace user as appropriate
chmod 0750 /var/db/pomf && chmod 0640 /var/db/pomf/sq3

Edit the file php/includes/settings.inc.php, in your source directory, making the changes outlined below. Note, changing the second two lines is optional, as they are simply ignored when using SQLite.

define('POMF_DB_CONN', '[stuff]'); ---> define('POMF_DB_CONN', 'sqlite:/var/db/pomf/pomf.sq3');
define('POMF_DB_USER', '[stuff]'); ---> define('POMF_DB_USER', null);
define('POMF_DB_PASS', '[stuff]'); ---> define('POMF_DB_PASS', null);

Then, run make DESTDIR=/path/to/main_site/testing_dir (note the testing_dir component) to rebuild the website, and copy it into place, in a new testing subdirectory.

Now, navigate to this subdirectory in your web browser, e.g. http://example.com/testing_dir, and verify that uploading works fine. If so, excellent! You may rerun make DESTDIR=/path/to/main_site to update your main site.

All done! You may disable or uninstall MySQL if you wish.

Getting help

The Pomf community gathers on IRC. You can also email the maintainer for help.

  • IRC (users): #pomfret on Rizon (irc.rizon.net)

Contributing

We'd really like if you can take some time to make sure your coding style is consistent with the project. Pomf follows PHP PSR-2 and Airbnb JavaScript (ES5) (airbnb/legacy) coding style guides. We use ESLint and PHPCS tools to enforce these standards.

You can also help by sending us feature requests or writing documentation and tests.

Thanks!

Credits

Pomf was created by Eric Johansson and Peter Lejeck for Pomf.se. The software is currently maintained by the community.

License

Pomf is free software, and is released under the terms of the Expat license. See LICENSE.