Simple file uploading and sharing
Pomf is a simple file uploading and sharing platform.
See the ((slightly modified)) real world example at safe.moe.
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.
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.
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.
bash git clone --recursive https://github.com/pomf/pomfIf you don't want either of the submodules run the following command,
bash 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
Run the following commands to do so. ```bash cd pomf/ make
make MODULES="" # compile no submodules; exclude the default php backend module make MODULES="php moe" # compile the php and moe submodules
ORbash make install DESTDIR=/desired/path/for/site ``
After this, the pomf site is now compressed and set up insidedist/
, or, if specified,DESTDIR`.
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
makefrom 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.iniand webserver configuration. For PHP, modify
post_max_sizevalues. The configuration option for nginx webserver is
Example nginx configs can be found in confs/.
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.
sqlite3 /var/db/pomf/pomf.sq3 -init /home/pomf/sqlite_schema.sql. Then, finally, ensure the permissions are correct, e.g.
bash chown nginx:nginx /var/db/pomf chmod 0750 /var/db/pomf chmod 0640 /var/db/pomf/pomf.sq3
php/includes/settings.inc.phpto indicate this is the database engine you would like to use. Make the changes outlined below
php 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
If you are running Apache and want to compress your output when serving files, add to your
Remember to enable
filter_modulemodules in your Apache configuration file.
, 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.
bash 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/sq3Edit 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.
php 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/testingdir, and verify that uploading works fine. If so, excellent! You may rerun `make DESTDIR=/path/to/mainsite` to update your main site.
All done! You may disable or uninstall MySQL if you wish.
The Pomf community gathers on IRC. You can also email the maintainer for help.
#pomfreton Rizon (
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.
Pomf was created by Eric Johansson and Peter Lejeck for Pomf.se. The software is currently maintained by the community.
Pomf is free software, and is released under the terms of the Expat license. See