diff --git a/.gitignore b/.gitignore index f5eab43..2f75ca1 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,17 @@ -vendor/* -resources/cryptopaste.db -config.ini +/.web-server-pid +/app/config/parameters.yml +/build/ +/phpunit.xml +/var/* +!/var/cache +/var/cache/* +!var/cache/.gitkeep +!/var/logs +/var/logs/* +!var/logs/.gitkeep +!/var/sessions +/var/sessions/* +!var/sessions/.gitkeep +!var/SymfonyRequirements.php +/vendor/ +/web/bundles/ diff --git a/.travis.yml b/.travis.yml index a24f319..ddaff9d 100644 --- a/.travis.yml +++ b/.travis.yml @@ -3,6 +3,7 @@ language: php php: - '7.0' - '7.1' + - '7.2' before_script: - composer self-update diff --git a/CHANGELOG.md b/CHANGELOG.md index ae0e9dd..ae3ec3a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file. Versions fo ### Added - Nothing yet, submit Pull Requests! +## [1.0.0] - 2018-09-xx - First release "[Rijmen](https://en.wikipedia.org/wiki/Vincent_Rijmen)" +### Changed +- Completely recoded everything in the Symfony 3.4 framework +- Fixed opened bugs +- Added functionality that confirms loading a burn-after-reading paste (prevents social media or messenger app pre-loads from deleting them) + ## [0.1.0] - 2017-06-11 - Initial Beta "[Daemen](https://en.wikipedia.org/wiki/Joan_Daemen)" ### Added - Initial Silex structure, controllers, and Doctrine DB interfaces diff --git a/README.md b/README.md index e57e437..62cdd84 100644 --- a/README.md +++ b/README.md @@ -1,35 +1,30 @@ - +
- map $remote_addr $ip_anonym1 { - default 0.0.0; - "~(?P<ip>(\d+)\.(\d+)\.(\d+))\.\d+" $ip; - "~(?P<ip>[^:]+:[^:]+):" $ip; - } - - map $remote_addr $ip_anonym2 { - default .0; - "~(?P<ip>(\d+)\.(\d+)\.(\d+))\.\d+" .0; - "~(?P<ip>[^:]+:[^:]+):" ::; - } - - map $ip_anonym1$ip_anonym2 $ip_anonymized { - default 0.0.0.0; - "~(?P<ip>.*)" $ip; - } - - log_format anonymized '$ip_anonymized - $remote_user [$time_local] ' - '"$request" $status $body_bytes_sent ' - '"$http_referer" "$http_user_agent"'; - - access_log /var/log/nginx/access.log anonymized; +http { + + # These maps anonymize IP addresses in nginx logs + + map $remote_addr $ip_anonym1 { + default 0.0.0; + "~(?P<ip>(\d+)\.(\d+)\.(\d+))\.\d+" $ip; + "~(?P<ip>[^:]+:[^:]+):" $ip; + } + + map $remote_addr $ip_anonym2 { + default .0; + "~(?P<ip>(\d+)\.(\d+)\.(\d+))\.\d+" .0; + "~(?P<ip>[^:]+:[^:]+):" ::; + } + + map $ip_anonym1$ip_anonym2 $ip_anonymized { + default 0.0.0.0; + "~(?P<ip>.*)" $ip; + } + + log_format anonymized '$ip_anonymized - $remote_user [$time_local] ' + '"$request" $status $body_bytes_sent ' + '"$http_referer" "$http_user_agent"'; + + access_log /var/log/nginx/access.log anonymized; +} + +server { + listen 80; + server_name _; + access_log /var/log/nginx/access.log anonymized; + + root /path/to/cryptopaste/web; + + index app.php; + location ~ /\.ht { + deny all; + } + location / { + try_files $uri /app.php$is_args$args; + } + + location ~ ^/app\.php(/|$) { + fastcgi_pass unix:/var/run/php-fpm.sock; + fastcgi_split_path_info ^(.+\.php)(/.*)$; + include fastcgi_params; + fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; + fastcgi_param PATH_INFO $fastcgi_script_name; + fastcgi_param SERVER_NAME $host; + } +}-5. In your `nginx.conf`, in the `server` block, this is all you need to run the CryptoPaste app: +4. If you chose not to enable the web cron, add an entry to your crontab to ensure deletion of expired pastes and sessions. Here is an example crontab entry that is run every hour as the `www-data` user:
- location ~ /securimage/(images/.*|securimage(_play\.swf|\.js|\.css))$ { - try_files $uri $uri/ =404; - alias /var/www/cryptopaste/vendor/dapphp; - } - - location / { - try_files $uri /index.php$is_args$args; - } - - location ~ ^/index\.php(/|$) { - fastcgi_pass unix:/var/run/php-fpm.sock; # Change this to reflect how your PHP-FPM is running - fastcgi_split_path_info ^(.+\.php)(/.*)$; - include fastcgi_params; - fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; - fastcgi_param PATH_INFO $fastcgi_script_name; - fastcgi_param SERVER_NAME $host; - } +0 * * * * www-data /usr/bin/php /path/to/cryptopaste/bin/console cron:run-6. Add a CRON entry to force deletion of expired pastes. Here is an example crontab entry that is run every 5 minutes as the `www-data` user: +# Upgrade + +Because Silex is now end-of-life, CryptoPaste v1.0 is a complete recode in the Symfony 3.4 framework. This has resulted in some major changes, but your data should be portable from a v0.x version of CryptoPaste. + +## Warning about SQLite + +CryptoPaste v1.x no longer supports SQLite. If you were using SQLite, please convert it to a MySQL database, table name of `cryptopaste`, and follow the upgrade procedure below. + +## Upgrade from v0.1.x to v1.x + +1. Make sure to backup your database and your `config.ini` file! You will need the data from your `config.ini` in the next steps. + +2. Delete your old v0.x CryptoPaste installation, but do not delete your database! + +3. Follow **all** of the instructions for Installation above, including for cron jobs and nginx settings. When prompted for configuration settings during the `composer install` phase, use the values from your `config.ini`. You will need to provide MySQL credentials for a user that can create and alter tables. + +4. When you run the `bin/console doctrine:migrations:migrate` command from the Installation instructions, this will automatically convert your database for CryptoPaste v1.x. + +## Upgrade v1.x + +1. Make sure you backup your database and `app/config/parameters.yml` file! + +2. If you cloned this repository, `cd` into your CryptoPaste installation directory and run `git pull`. If not, you will need to clone or download this repository to a new directory, then move your old `app/config/parameters.yml` file and any custom templates into your that new directory. + +3. Next, run + +`$ composer install` + +Because CryptoPaste uses the Symfony framework, Composer will automatically prompt you for any new configuration settings. Unfortunately this does not include definitions in the prompts, so please read the comments in `app/config/parameters.yml.dist` for an explanation of what the configuration settings are. + +If you want to change the configuration settings later (i.e. changing to a DB user will limited permissions), they are saved in the `app/config/parameters.yml` file. + +4. Update the database using the following command: + +`$ php bin/console doctrine:migrations:migrate` + +This will update the database schema using the username and password specified in your `app/config/parameters.yml` file. The database user you specified will need enough permissions to modify the database and so forth. If you want to specify a different user to do this, edit the `app/config/parameters.yml` file. + +5. Clear the CryptoPaste application cache by running the following command: + +`$ php bin/console cache:clear` + +# Modify the template + +Note that all template files are written in [Twig 2.0](https://twig.symfony.com). You can find the documentation for it [here](https://twig.symfony.com/doc/2.x/). + +## Override default template files + +All default template files reside in `app/Resources/views/default/`. If you want to override any file here, simply copy the file to the `custom/` directory one level up and modify as needed. For example, if you want to override the FAQ page, you would copy `app/Resources/views/default/pages/faq.html.twig` to `app/Resources/views/custom/pages/faq.html.twig`. + +## Add custom static pages + +If you want to add custom static pages, i.e. a privacy policy or terms of service, you can do that quite easily as described below. + +### Custom page file + +First, create a file in `app/Resources/views/custom/pages/` that must end in `.html.twig`. The part before `.html.twig` will become the page *slug*, or identifier, used in the URL and menu. For example, if you create `app/Resources/views/custom/pages/privacy.html.twig`, then "privacy" becomes the slug. + +Two Twig settings must exist within a custom page: + +* **extends** - Must be set exactly as shown below in the example +* **content** block - The HTML to display + +There are also some optional settings: + +* **title** - Page title that shows up in the `