From 9b6aa038728b3bc93c5d8a62a38213b4dceb484b Mon Sep 17 00:00:00 2001 From: Menno van Leeuwen Date: Wed, 16 Jul 2025 01:58:49 +0200 Subject: [PATCH] feat: add PrivateBin service deployment with Docker and configuration files --- config/ansible/tasks/servers/server.yml | 4 + .../tasks/servers/services/caddy/Caddyfile.j2 | 5 + .../servers/services/privatebin/conf.php.j2 | 300 ++++++++++++++++++ .../services/privatebin/docker-compose.yml.j2 | 27 ++ .../services/privatebin/privatebin.yml | 42 +++ 5 files changed, 378 insertions(+) create mode 100644 config/ansible/tasks/servers/services/privatebin/conf.php.j2 create mode 100644 config/ansible/tasks/servers/services/privatebin/docker-compose.yml.j2 create mode 100644 config/ansible/tasks/servers/services/privatebin/privatebin.yml diff --git a/config/ansible/tasks/servers/server.yml b/config/ansible/tasks/servers/server.yml index 6889a7f..a91194e 100644 --- a/config/ansible/tasks/servers/server.yml +++ b/config/ansible/tasks/servers/server.yml @@ -90,6 +90,10 @@ enabled: true hosts: - mennos-server + - name: privatebin + enabled: true + hosts: + - mennos-server - name: unifi-network-application enabled: true hosts: diff --git a/config/ansible/tasks/servers/services/caddy/Caddyfile.j2 b/config/ansible/tasks/servers/services/caddy/Caddyfile.j2 index b534bb1..28b4b5c 100644 --- a/config/ansible/tasks/servers/services/caddy/Caddyfile.j2 +++ b/config/ansible/tasks/servers/services/caddy/Caddyfile.j2 @@ -148,4 +148,9 @@ home.vleeuwen.me { } tls {{ caddy_email }} } +bin.mvl.sh { + import country_block + reverse_proxy privatebin:8080 + tls {{ caddy_email }} +} {% endif %} diff --git a/config/ansible/tasks/servers/services/privatebin/conf.php.j2 b/config/ansible/tasks/servers/services/privatebin/conf.php.j2 new file mode 100644 index 0000000..b91b6a8 --- /dev/null +++ b/config/ansible/tasks/servers/services/privatebin/conf.php.j2 @@ -0,0 +1,300 @@ +;project page." + +; (optional) notice to display +; notice = "Note: This is a test service: Data may be deleted anytime. Kittens will die if you abuse this service." + +; by default PrivateBin will guess the visitors language based on the browsers +; settings. Optionally you can enable the language selection menu, which uses +; a session cookie to store the choice until the browser is closed. +languageselection = false + +; set the language your installs defaults to, defaults to English +; if this is set and language selection is disabled, this will be the only language +; languagedefault = "en" + +; (optional) URL shortener address to offer after a new paste is created. +; It is suggested to only use this with self-hosted shorteners as this will leak +; the pastes encryption key. +; urlshortener = "https://shortener.example.com/api?link=" + +; (optional) Let users create a QR code for sharing the paste URL with one click. +; It works both when a new paste is created and when you view a paste. +qrcode = true + +; (optional) Let users send an email sharing the paste URL with one click. +; It works both when a new paste is created and when you view a paste. +; email = true + +; (optional) IP based icons are a weak mechanism to detect if a comment was from +; a different user when the same username was used in a comment. It might get +; used to get the IP of a comment poster if the server salt is leaked and a +; SHA512 HMAC rainbow table is generated for all (relevant) IPs. +; Can be set to one these values: +; "none" / "identicon" / "jdenticon" (default) / "vizhash". +; icon = "none" + +; Content Security Policy headers allow a website to restrict what sources are +; allowed to be accessed in its context. You need to change this if you added +; custom scripts from third-party domains to your templates, e.g. tracking +; scripts or run your site behind certain DDoS-protection services. +; Check the documentation at https://content-security-policy.com/ +; Notes: +; - If you use the bootstrap5 theme, you must change default-src to 'self' to +; enable display of the svg icons +; - By default this disallows to load images from third-party servers, e.g. when +; they are embedded in pastes. If you wish to allow that, you can adjust the +; policy here. See https://github.com/PrivateBin/PrivateBin/wiki/FAQ#why-does-not-it-load-embedded-images +; for details. +; - The 'wasm-unsafe-eval' is used to enable webassembly support (used for zlib +; compression). You can remove it if compression doesn't need to be supported. +; - The 'unsafe-inline' style-src is used by Chrome when displaying PDF previews +; and can be omitted if attachment upload is disabled (which is the default). +; See https://issues.chromium.org/issues/343754409 +; - To allow displaying PDF previews in Firefox or Chrome, sandboxing must also +; get turned off. The following CSP allows PDF previews: +; cspheader = "default-src 'none'; base-uri 'self'; form-action 'none'; manifest-src 'self'; connect-src * blob:; script-src 'self' 'wasm-unsafe-eval'; style-src 'self' 'unsafe-inline'; font-src 'self'; frame-ancestors 'none'; frame-src blob:; img-src 'self' data: blob:; media-src blob:; object-src blob:" +; +; The recommended and default used CSP is: +; cspheader = "default-src 'none'; base-uri 'self'; form-action 'none'; manifest-src 'self'; connect-src * blob:; script-src 'self' 'wasm-unsafe-eval'; style-src 'self'; font-src 'self'; frame-ancestors 'none'; frame-src blob:; img-src 'self' data: blob:; media-src blob:; object-src blob:; sandbox allow-same-origin allow-scripts allow-forms allow-modals allow-downloads" + +; stay compatible with PrivateBin Alpha 0.19, less secure +; if enabled will use base64.js version 1.7 instead of 2.1.9 and sha1 instead of +; sha256 in HMAC for the deletion token +; zerobincompatibility = false + +; Enable or disable the warning message when the site is served over an insecure +; connection (insecure HTTP instead of HTTPS), defaults to true. +; Secure transport methods like Tor and I2P domains are automatically whitelisted. +; It is **strongly discouraged** to disable this. +; See https://github.com/PrivateBin/PrivateBin/wiki/FAQ#why-does-it-show-me-an-error-about-an-insecure-connection for more information. +; httpwarning = true + +; Pick compression algorithm or disable it. Only applies to pastes/comments +; created after changing the setting. +; Can be set to one these values: "none" / "zlib" (default). +; compression = "zlib" + +[expire] +; expire value that is selected per default +; make sure the value exists in [expire_options] +default = "1week" + +[expire_options] +; Set each one of these to the number of seconds in the expiration period, +; or 0 if it should never expire +5min = 300 +10min = 600 +1hour = 3600 +1day = 86400 +1week = 604800 +; Well this is not *exactly* one month, it's 30 days: +1month = 2592000 +1year = 31536000 +never = 0 + +[formatter_options] +; Set available formatters, their order and their labels +plaintext = "Plain Text" +syntaxhighlighting = "Source Code" +markdown = "Markdown" + +[traffic] +; time limit between calls from the same IP address in seconds +; Set this to 0 to disable rate limiting. +limit = 10 + +; (optional) Set IPs addresses (v4 or v6) or subnets (CIDR) which are exempted +; from the rate-limit. Invalid IPs will be ignored. If multiple values are to +; be exempted, the list needs to be comma separated. Leave unset to disable +; exemptions. +; exempted = "1.2.3.4,10.10.10/24" + +; (optional) If you want only some source IP addresses (v4 or v6) or subnets +; (CIDR) to be allowed to create pastes, set these here. Invalid IPs will be +; ignored. If multiple values are to be exempted, the list needs to be comma +; separated. Leave unset to allow anyone to create pastes. +; creators = "1.2.3.4,10.10.10/24" + +; (optional) if your website runs behind a reverse proxy or load balancer, +; set the HTTP header containing the visitors IP address, i.e. X_FORWARDED_FOR +; header = "X_FORWARDED_FOR" + +[purge] +; minimum time limit between two purgings of expired pastes, it is only +; triggered when pastes are created +; Set this to 0 to run a purge every time a paste is created. +limit = 300 + +; maximum amount of expired pastes to delete in one purge +; Set this to 0 to disable purging. Set it higher, if you are running a large +; site +batchsize = 10 + +[model] +; name of data model class to load and directory for storage +; the default model "Filesystem" stores everything in the filesystem +class = Filesystem +[model_options] +dir = PATH "data" + +;[model] +; example of a Google Cloud Storage configuration +;class = GoogleCloudStorage +;[model_options] +;bucket = "my-private-bin" +;prefix = "pastes" +;uniformacl = false + +;[model] +; example of DB configuration for MySQL +;class = Database +;[model_options] +;dsn = "mysql:host=localhost;dbname=privatebin;charset=UTF8" +;tbl = "privatebin_" ; table prefix +;usr = "privatebin" +;pwd = "Z3r0P4ss" +;opt[12] = true ; PDO::ATTR_PERSISTENT + +;[model] +; example of DB configuration for SQLite +;class = Database +;[model_options] +;dsn = "sqlite:" PATH "data/db.sq3" +;usr = null +;pwd = null +;opt[12] = true ; PDO::ATTR_PERSISTENT + +;[model] +; example of DB configuration for PostgreSQL +;class = Database +;[model_options] +;dsn = "pgsql:host=localhost;dbname=privatebin" +;tbl = "privatebin_" ; table prefix +;usr = "privatebin" +;pwd = "Z3r0P4ss" +;opt[12] = true ; PDO::ATTR_PERSISTENT + +;[model] +; example of S3 configuration for Rados gateway / CEPH +;class = S3Storage +;[model_options] +;region = "" +;version = "2006-03-01" +;endpoint = "https://s3.my-ceph.invalid" +;use_path_style_endpoint = true +;bucket = "my-bucket" +;accesskey = "my-rados-user" +;secretkey = "my-rados-pass" + +;[model] +; example of S3 configuration for AWS +;class = S3Storage +;[model_options] +;region = "eu-central-1" +;version = "latest" +;bucket = "my-bucket" +;accesskey = "access key id" +;secretkey = "secret access key" + +;[model] +; example of S3 configuration for AWS using its SDK default credential provider chain +; if relying on environment variables, the AWS SDK will look for the following: +; - AWS_ACCESS_KEY_ID +; - AWS_SECRET_ACCESS_KEY +; - AWS_SESSION_TOKEN (if needed) +; for more details, see https://docs.aws.amazon.com/sdk-for-php/v3/developer-guide/guide_credentials.html#default-credential-chain +;class = S3Storage +;[model_options] +;region = "eu-central-1" +;version = "latest" +;bucket = "my-bucket" + +;[yourls] +; When using YOURLS as a "urlshortener" config item: +; - By default, "urlshortener" will point to the YOURLS API URL, with or without +; credentials, and will be visible in public on the PrivateBin web page. +; Only use this if you allow short URL creation without credentials. +; - Alternatively, using the parameters in this section ("signature" and +; "apiurl"), "urlshortener" needs to point to the base URL of your PrivateBin +; instance with "?shortenviayourls&link=" appended. For example: +; urlshortener = "${basepath}?shortenviayourls&link=" +; This URL will in turn call YOURLS on the server side, using the URL from +; "apiurl" and the "access signature" from the "signature" parameters below. + +; (optional) the "signature" (access key) issued by YOURLS for the using account +; signature = "" +; (optional) the URL of the YOURLS API, called to shorten a PrivateBin URL +; apiurl = "https://yourls.example.com/yourls-api.php" + +;[sri] +; Subresource integrity (SRI) hashes used in template files. Uncomment and set +; these for all js files used. See: +; https://github.com/PrivateBin/PrivateBin/wiki/FAQ#user-content-how-to-make-privatebin-work-when-i-have-changed-some-javascript-files +;js/privatebin.js = "sha512-[…]" \ No newline at end of file diff --git a/config/ansible/tasks/servers/services/privatebin/docker-compose.yml.j2 b/config/ansible/tasks/servers/services/privatebin/docker-compose.yml.j2 new file mode 100644 index 0000000..3908c5b --- /dev/null +++ b/config/ansible/tasks/servers/services/privatebin/docker-compose.yml.j2 @@ -0,0 +1,27 @@ +services: + privatebin: + image: privatebin/nginx-fpm-alpine:latest + container_name: privatebin + restart: always + read_only: true + user: "1000:1000" + environment: + - PUID=1000 + - PGID=1000 + - TZ=Europe/Amsterdam + volumes: + - {{ privatebin_data_dir }}:/srv/data + - {{ privatebin_service_dir }}/conf.php:/srv/cfg/conf.php:ro + healthcheck: + test: ["CMD-SHELL", "nc -z 127.0.0.1 8080 || exit 1"] + interval: 10s + timeout: 5s + retries: 3 + start_period: 90s + networks: + - caddy_network + +networks: + caddy_network: + external: true + name: caddy_default diff --git a/config/ansible/tasks/servers/services/privatebin/privatebin.yml b/config/ansible/tasks/servers/services/privatebin/privatebin.yml new file mode 100644 index 0000000..5b799a8 --- /dev/null +++ b/config/ansible/tasks/servers/services/privatebin/privatebin.yml @@ -0,0 +1,42 @@ +--- +- name: Deploy PrivateBin service + block: + - name: Set PrivateBin directories + ansible.builtin.set_fact: + privatebin_data_dir: "{{ '/mnt/services/privatebin' if inventory_hostname == 'mennos-server' else '/mnt/object_storage/services/privatebin' }}" + privatebin_service_dir: "{{ ansible_env.HOME }}/services/privatebin" + + - name: Create PrivateBin directories + ansible.builtin.file: + path: "{{ privatebin_dir }}" + state: directory + mode: "0755" + loop: + - "{{ privatebin_data_dir }}" + - "{{ privatebin_service_dir }}" + loop_control: + loop_var: privatebin_dir + + - name: Deploy PrivateBin docker-compose.yml + ansible.builtin.template: + src: docker-compose.yml.j2 + dest: "{{ privatebin_service_dir }}/docker-compose.yml" + mode: "0644" + register: privatebin_compose + + - name: Deploy PrivateBin conf.php + ansible.builtin.template: + src: conf.php.j2 + dest: "{{ privatebin_service_dir }}/conf.php" + mode: "0644" + + - name: Stop PrivateBin service + ansible.builtin.command: docker compose -f "{{ privatebin_service_dir }}/docker-compose.yml" down --remove-orphans + when: privatebin_compose.changed + + - name: Start PrivateBin service + ansible.builtin.command: docker compose -f "{{ privatebin_service_dir }}/docker-compose.yml" up -d + when: privatebin_compose.changed + tags: + - services + - privatebin