fix(box): wallabag is working again!!!

This commit is contained in:
Anish Lakhwara 2024-07-14 20:20:49 -07:00
parent 07891dc81d
commit c1af9a9ca7
7 changed files with 281 additions and 300 deletions

View file

@ -1,10 +1,10 @@
{ self, pkgs, config, lib, ... }: { self, pkgs, config, lib, ... }:
{ {
# age.secrets.wallabag-password.file = "${self}/secrets/wallabag-password.age"; age.secrets.wallabag-password.file = "${self}/secrets/wallabag-password.age";
# age.secrets.wallabag-secret.file = "${self}/secrets/wallabag-secret.age"; age.secrets.wallabag-secret.file = "${self}/secrets/wallabag-secret.age";
# age.secrets.wallabag-password.owner = "wallabag"; age.secrets.wallabag-password.owner = "wallabag";
# age.secrets.wallabag-secret.owner = "wallabag"; age.secrets.wallabag-secret.owner = "wallabag";
services.postgresql = { services.postgresql = {
enable = true; enable = true;
package = pkgs.postgresql_15; package = pkgs.postgresql_15;
@ -18,74 +18,20 @@
} }
]; ];
authentication = '' authentication = ''
local wallabag all md5 local wallabag all peer
''; '';
}; };
services.wallabag = { services.wallabag = {
enable = true; enable = true;
hostName = "read.mossnet.lan"; domain = "read.mossnet.lan";
virtualHost.enable = true;
package = pkgs.my-wallabag; package = pkgs.my-wallabag;
dataDir = "/var/lib/wallabag"; # Systemd now defaults to /var/lib?
conf = '' # dataDir = "/var/lib/wallabag";
# This file is a "template" of what your parameters.yml file should look like parameters = {
parameters: "env(SECRET_FILE)" = config.age.secrets.wallabag-secret.path;
database_driver: pdo_pgsql secret = "%env(file:resolve:SECRET_FILE)%";
database_host: localhost };
database_port: ~
database_name: wallabag
database_user: wallabag
database_password: wallabag
# For SQLite, database_path should be "%kernel.project_dir%/data/db/wallabag.sqlite"
database_path: ~
database_table_prefix: wallabag_
database_socket: null
# with PostgreSQL and SQLite, you must set "utf8"
database_charset: utf8
domain_name: http://read.mossnet.lan
server_name: "mossnet wallabag instance"
mailer_dsn: null://
locale: en
# A secret key that's used to generate certain security-related tokens
secret: SAFGOECRIlfal89oe6u0(*^dsaaih961
# two factor stuff
twofactor_auth: false
twofactor_sender: no-reply@wallabag.org
# fosuser stuff
fosuser_registration: false
fosuser_confirmation: true
# how long the access token should live in seconds for the API
fos_oauth_server_access_token_lifetime: 3600
# how long the refresh token should life in seconds for the API
fos_oauth_server_refresh_token_lifetime: 1209600
from_email: ops@sealight.xyz
rss_limit: 50
# RabbitMQ processing
rabbitmq_host: localhost
rabbitmq_port: 5672
rabbitmq_user: guest
rabbitmq_password: guest
rabbitmq_prefetch_count: 10
# Redis processing
redis_scheme: tcp
redis_host: localhost
redis_port: 6379
redis_path: null
redis_password: null
# sentry logging
sentry_dsn: ~
'';
}; };
# networking.firewall.allowedTCPPorts = [ 8080 ];
} }

View file

@ -9,5 +9,6 @@
wireguard = import ./wireguard.nix; wireguard = import ./wireguard.nix;
backup = import ./backup.nix; backup = import ./backup.nix;
ulogger-server = import ./ulogger.nix; ulogger-server = import ./ulogger.nix;
blogg = import ./blogging.nix;
# microbin = import ./microbin.nix; # includide in 23.11 # microbin = import ./microbin.nix; # includide in 23.11
} }

View file

@ -1,253 +1,245 @@
{ config, options, lib, pkgs, ... }: { config, lib, pkgs, ... }:
with lib;
let let
# Based on https://github.com/wallabag/wallabag/blob/2.6.6/app/config/parameters.yml.dist
settings = {
database_driver = "${cfg.database_type}";
database_host = null;
database_port = 5432;
database_name = "wallabag";
database_user = "wallabag";
database_password = null;
database_path = null;
database_table_prefix = "wallabag_";
database_socket = "/run/postgresql";
database_charset = "utf8";
domain_name = "http://${cfg.domain}";
server_name = "Wallabag";
# Needs an explicit command since Symfony version used by Wallabag does not yet support the `native` transport
# and the `sendmail` transport does not respect `sendmail_path` configured in `php.ini`.
mailer_dsn = "sendmail://default?command=/run/wrappers/bin/sendmail%%20-t%%20-i";
locale = "en";
# A secret key that's used to generate certain security-related tokens.
# "env(SECRET_FILE)" = "/run/secrets/wallabag";
# secret = "%env(file:resolve:SECRET_FILE)%";
# two factor stuff
twofactor_auth = false;
twofactor_sender = "";
# fosuser stuff
fosuser_registration = false;
fosuser_confirmation = false;
# how long the access token should live in seconds for the API
fos_oauth_server_access_token_lifetime = 3600;
# how long the refresh token should life in seconds for the API
fos_oauth_server_refresh_token_lifetime = 1209600;
from_email = "wallabag@read.mossnet.lan";
# RabbitMQ processing
redis_scheme = "unix";
redis_host = ""; # Ignored for unix scheme
redis_port = 0; # Ignored for unix scheme
redis_path = config.services.redis.servers.wallabag.unixSocket;
redis_password = null;
# Redis processing
rabbitmq_host = "";
rabbitmq_port = 0;
rabbitmq_user = "";
rabbitmq_password = "";
rabbitmq_prefetch_count = 0;
# sentry logging
sentry_dsn = null;
} // cfg.parameters;
php = cfg.php.package.withExtensions ({ enabled, all }: enabled ++ (with all; [
imagick
tidy
]));
commonServiceConfig = {
CacheDirectory = "wallabag";
# Stores sessions.
CacheDirectoryMode = "700";
ConfigurationDirectory = "wallabag";
LogsDirectory = "wallabag";
StateDirectory = "wallabag";
# Stores site-credentials-secret-key.txt.
StateDirectoryMode = "700";
};
cfg = config.services.wallabag; cfg = config.services.wallabag;
in {
options.services.wallabag = with lib; {
enable = mkEnableOption (mdDoc "Wallabag read-it-later service");
poolName = "wallabag"; package = mkOption {
type = types.package;
default = pkgs.wallabag;
};
configFile = pkgs.writeTextFile { php.package = mkOption {
name = "wallabag-config"; type = types.package;
text = cfg.conf; default = pkgs.php;
destination = "/app/config/parameters.yml"; };
parameters = mkOption {
type = types.attrsOf types.str;
default = {};
description = mdDoc "Parameters to override from the default. See <https://doc.wallabag.org/en/admin/parameters.html> for values.";
};
database_type = mkOption {
type = types.enum [
"pdo_sqlite3"
"pdo_pgsql"
];
default = if config.services.postgresql.enable
then "pdo_pgsql"
else "pdo_sqlite3";
defaultText = ''
if config.services.postgresql.enable
then "pdo_pgsql"
else "pdo_sqlite3"
'';
description = mdDoc ''
The database engine name. Can be pdo_sqlite3 or pdo_pgsql.
'';
};
domain = mkOption {
type = types.str;
description = "Bare domain name for Wallabag";
};
virtualHost.enable = mkEnableOption (mdDoc "Define nginx virtualhost for Wallabag");
}; };
appDir = pkgs.buildEnv { config = lib.mkIf cfg.enable {
name = "wallabag-app-dir"; environment.etc."wallabag/parameters.yml" = {
ignoreCollisions = true; source = pkgs.writeTextFile {
checkCollisionContents = false; name = "wallabag-config";
paths = [ configFile "${cfg.package}" ]; text = builtins.toJSON {
pathsToLink = [ "/app" "/src" "/translations" ]; parameters = settings;
}; };
# See there for available commands:
# https://doc.wallabag.org/en/admin/console_commands.html
# A user can be made admin with the fos:user:promote --super <user> command
console = pkgs.writeShellScriptBin "wallabag-console" ''
export WALLABAG_DATA="${cfg.dataDir}"
cd "${cfg.dataDir}"
${pkgs.php}/bin/php ${cfg.package}/bin/console --env=prod $@
'';
in
{
options = {
services.wallabag = {
enable = mkEnableOption "wallabag";
user = mkOption {
type = types.str;
default = "nginx";
description = ''
User account under which both the update daemon and the web-application run.
'';
};
dataDir = mkOption {
type = types.path;
default = "/var/lib/wallabag";
description = ''
Data directory.
'';
};
package = mkOption {
type = types.package;
default = pkgs.wallabag;
description = ''
Wallabag package to use.
'';
};
hostName = mkOption {
type = types.str;
description = ''
Name of the nginx virtualhost to use and setup.
'';
};
poolConfig = mkOption {
type = types.lines;
default = ''
pm = dynamic
pm.max_children = 75
pm.start_servers = 1
pm.min_spare_servers = 1
pm.max_spare_servers = 20
pm.max_requests = 500
catch_workers_output = 1
'';
description = ''
Options for wallabag's PHP pool. See the documentation on <literal>php-fpm.conf</literal> for details on configuration directives.
'';
};
conf = mkOption {
type = types.str;
description = ''
Contents of the wallabag configuration file (parameters.yml)
'';
}; };
}; };
};
services.nginx = lib.mkIf cfg.virtualHost.enable {
enable = true;
config = mkIf cfg.enable { virtualHosts = {
"${cfg.domain}" = {
root = "${pkgs.wallabag}/web";
services.phpfpm.pools."${poolName}" = { extraConfig = ''
user = "${cfg.user}"; add_header X-Frame-Options SAMEORIGIN;
group = "nginx"; add_header X-Content-Type-Options nosniff;
phpPackage = pkgs.php; add_header X-XSS-Protection "1; mode=block";
phpEnv = { '';
WALLABAG_DATA = cfg.dataDir;
PATH = lib.makeBinPath [pkgs.php]; locations."/" = {
extraConfig = ''
try_files $uri /app.php$is_args$args;
'';
};
locations."/assets".root = "${pkgs.wallabag}/app/web";
locations."~ ^/app\\.php(/|$)" = {
extraConfig = ''
fastcgi_pass unix:${config.services.phpfpm.pools.wallabag.socket};
include ${config.services.nginx.package}/conf/fastcgi.conf;
fastcgi_param PATH_INFO $fastcgi_path_info;
fastcgi_param PATH_TRANSLATED $document_root$fastcgi_path_info;
fastcgi_param SCRIPT_FILENAME ${pkgs.wallabag}/web/$fastcgi_script_name;
fastcgi_param DOCUMENT_ROOT ${pkgs.wallabag}/web;
fastcgi_read_timeout 120;
internal;
'';
};
locations."~ /(?!app)\\.php$" = {
extraConfig = ''
return 404;
'';
};
};
}; };
};
services.phpfpm.pools.wallabag = {
user = config.users.users.wallabag.name;
phpPackage = php;
settings = { settings = {
"listen.owner" = "nginx"; "catch_workers_output" = true;
"listen.group" = "nginx";
"listen.mode" = "0600"; "listen.owner" = config.services.nginx.user;
"user" = "${cfg.user}"; "listen.group" = "root";
"group" = "nginx";
"pm" = "dynamic"; "pm" = "dynamic";
"pm.max_children" = "75"; "pm.max_children" = 5;
"pm.min_spare_servers" = "5"; "pm.start_servers" = 2;
"pm.max_spare_servers" = "20"; "pm.min_spare_servers" = 1;
"pm.max_requests" = "10"; "pm.max_spare_servers" = 3;
"catch_workers_output" = "1"; "php_admin_value[error_log]" = "/var/log/wallabag/error.log";
"php_admin_value[error_log]" = "stderr"; "php_admin_value[access_log]" = "/var/log/wallabag/access.log";
"php_admin_flag[log_errors]" = true; "php_admin_flag[log_errors]" = true;
}; };
}; phpOptions = ''
services.phpfpm.phpOptions = '' ; Set up $_ENV superglobal.
max_execution_time = 120 ; http://php.net/request-order
variables_order = "EGPCS"
# Wallabag will crash on start-up.
# https://github.com/wallabag/wallabag/issues/6042
# error_reporting = E_ALL & ~E_USER_DEPRECATED & ~E_DEPRECATED
''; '';
settings = {
services.nginx.enable = mkDefault true; # Accept settings from the systemd service.
environment.systemPackages = [ console ]; clear_env = false;
# services.nginx.virtualHosts."${cfg.hostName}" = {
# forceSSL = false;
# enableACME = false;
# extraConfig = ''
# error_log /var/log/nginx/wallabag_error.log;
# access_log /var/log/nginx/wallabag_access.log;
# '';
# root = "${cfg.package}/web";
# locations."/" = {
# priority = 10;
# tryFiles = "$uri /app.php$is_args$args";
# };
# locations."/assets".root = "${cfg.dataDir}/web";
# locations."~ ^/app\\.php(/|$)" = {
# priority = 100;
# fastcgiParams = {
# SCRIPT_FILENAME = "$realpath_root$fastcgi_script_name";
# DOCUMENT_ROOT = "$realpath_root";
# };
# extraConfig = ''
# fastcgi_pass unix:${config.services.phpfpm.pools."${poolName}".socket};
# include ${config.services.nginx.package}/conf/fastcgi_params;
# include ${config.services.nginx.package}/conf/fastcgi.conf;
# internal;
# '';
# };
# locations."~ \\.php$" = {
# priority = 1000;
# return = "404";
# };
# };
services.nginx.virtualHosts."${cfg.hostName}" = {
enableACME = false;
forceSSL = false;
root = "${cfg.package}/web";
# extraConfig = ''
# add_header X-Frame-Options SAMEORIGIN;
# add_header X-Content-Type-Options nosniff;
# add_header X-XSS-Protection "1; mode=block";
# '';
locations."/" = {
tryFiles = "$uri /app.php$is_args$args";
};
locations."/assets".root = "${cfg.dataDir}/web";
locations."~ ^/app\\.php(/|$)" = {
# fastcgiParams = {
# SCRIPT_FILENAME = "$realpath_root$fastcgi_script_name";
# DOCUMENT_ROOT = "$realpath_root";
# };
extraConfig = ''
fastcgi_pass unix:${config.services.phpfpm.pools."${poolName}".socket};
fastcgi_split_path_info ^(.+\.php)(/.*)$;
include ${pkgs.nginx}/conf/fastcgi_params;
fastcgi_param SCRIPT_FILENAME ${cfg.package}/web/$fastcgi_script_name;
fastcgi_param DOCUMENT_ROOT ${cfg.package}/web;
fastcgi_read_timeout 120;
internal;
'';
};
locations."~ /(?!app)\\.php$" = {
extraConfig = ''
return 404;
'';
}; };
}; };
users.users.wallabag = {
isSystemUser = true;
group = "wallabag";
};
users.groups.wallabag = {};
services.redis.servers.wallabag = {
enable = true;
user = "wallabag";
};
services.rabbitmq.enable = false;
systemd.services.phpfpm-wallabag.serviceConfig = commonServiceConfig;
systemd.services.wallabag-install = { systemd.services.wallabag-install = {
description = "Wallabag install service"; description = "Wallabag install service";
wantedBy = [ "multi-user.target" ]; wantedBy = [ "multi-user.target" ];
before = [ "phpfpm-wallabag.service" ]; before = [ "phpfpm-wallabag.service" ];
after = [ "mysql.service" "postgresql.service" ]; after = [ "postgresql.service" ];
path = with pkgs; [ coreutils php phpPackages.composer ]; path = with pkgs; [ coreutils php phpPackages.composer ];
serviceConfig = { serviceConfig = {
User = cfg.user; User = "wallabag";
Type = "oneshot"; Type = "oneshot";
RemainAfterExit = "yes"; } // commonServiceConfig;
PermissionsStartOnly = true;
};
preStart = ''
mkdir -p "${cfg.dataDir}"
chown ${cfg.user}:nginx "${cfg.dataDir}"
'';
script = '' script = ''
echo "Setting up wallabag files in ${cfg.dataDir} ..." if [ ! -f "$STATE_DIRECTORY/installed" ]; then
cd "${cfg.dataDir}" php ${pkgs.wallabag}/bin/console --env=prod wallabag:install
touch "$STATE_DIRECTORY/installed"
rm -rf var/cache/* else
rm -f app src translations php ${pkgs.wallabag}/bin/console --env=prod doctrine:migrations:migrate --no-interaction
ln -sf ${appDir}/app app fi
ln -sf ${appDir}/src src php ${pkgs.wallabag}/bin/console --env=prod cache:clear
ln -sf ${appDir}/translations translations '';
ln -sf ${cfg.package}/composer.{json,lock} .
export WALLABAG_DATA="${cfg.dataDir}"
if [ ! -f installed ]; then
echo "Install file not found, installing ..."
php ${cfg.package}/bin/console --env=prod doctrine:database:create --if-not-exists --no-interaction
php ${cfg.package}/bin/console --env=prod doctrine:migrations:migrate --no-interaction
# Until https://github.com/wallabag/wallabag/issues/3662 is fixed
# yes no | php ${cfg.package}/bin/console --env=prod wallabag:install
touch installed
else
php ${cfg.package}/bin/console --env=prod doctrine:migrations:migrate --no-interaction
fi
php ${cfg.package}/bin/console --env=prod cache:clear
'';
}; };
}; };
meta = with stdenv.lib; {
maintainers = with maintainers; [ nadrieril ];
};
} }

View file

@ -14,6 +14,15 @@
buildInputs = prevAttrs.propagatedBuildInputs ++ [ final.python3.pkgs.aiosqlite ]; # We're using sqlite and upstream doesn't package this dependency buildInputs = prevAttrs.propagatedBuildInputs ++ [ final.python3.pkgs.aiosqlite ]; # We're using sqlite and upstream doesn't package this dependency
}); });
wallabag = prev.wallabag.overrideAttrs (attrs: {
patches = builtins.filter (patch: builtins.baseNameOf patch != "wallabag-data.patch") attrs.patches ++ [
# Out of the box, Wallabag wants to write to various subdirectories of the project directory.
# Lets replace references to such paths with designated systemd locations
# so that the project source can remain immutable.
../pkgs/wallabag-data.patch
];
});
# Need to do server and agent too, maybe # Need to do server and agent too, maybe
# woodpecker-cli-next = # woodpecker-cli-next =
# let # let

View file

@ -8,6 +8,10 @@
kobopatch = pkgs.callPackage ./kobopatch.nix { }; kobopatch = pkgs.callPackage ./kobopatch.nix { };
my-mautrix-discord = pkgs.callPackage ./mautrix-discord.nix { }; # Handled by matrix-appservices input my-mautrix-discord = pkgs.callPackage ./mautrix-discord.nix { }; # Handled by matrix-appservices input
ulogger-server = pkgs.callPackage ./ulogger.nix { }; ulogger-server = pkgs.callPackage ./ulogger.nix { };
# Wallabag is now an overlay
# TODO: we still use the patch from this folder though
my-wallabag = pkgs.callPackage ./wallabag.nix { }; my-wallabag = pkgs.callPackage ./wallabag.nix { };
mautrix-slack = pkgs.callPackage ./mautrix-slack.nix { }; mautrix-slack = pkgs.callPackage ./mautrix-slack.nix { };
gpodder2go = pkgs.callPackage ./gpodder2go.nix { };
ghost = pkgs.callPackage ./ghost { };
} }

View file

@ -1,26 +1,55 @@
diff --git a/app/AppKernel.php b/app/AppKernel.php diff --git a/app/AppKernel.php b/app/AppKernel.php
index 61b734e06..d25d1aaa3 100644 index 61b734e06..0902c20fc 100644
--- a/app/AppKernel.php --- a/app/AppKernel.php
+++ b/app/AppKernel.php +++ b/app/AppKernel.php
@@ -62,14 +62,19 @@ class AppKernel extends Kernel @@ -64,12 +64,12 @@ class AppKernel extends Kernel
return $bundles;
}
+ public function getProjectDir()
+ {
+ return getenv('WALLABAG_DATA') ?: dirname(__DIR__);
+ }
+
public function getCacheDir() public function getCacheDir()
{ {
- return dirname(__DIR__) . '/var/cache/' . $this->getEnvironment(); - return dirname(__DIR__) . '/var/cache/' . $this->getEnvironment();
+ return $this->getProjectDir() . '/var/cache/' . $this->getEnvironment(); + return getenv('CACHE_DIRECTORY') . '/' . $this->getEnvironment();
} }
public function getLogDir() public function getLogDir()
{ {
- return dirname(__DIR__) . '/var/logs'; - return dirname(__DIR__) . '/var/logs';
+ return $this->getProjectDir() . '/var/logs'; + return getenv('LOGS_DIRECTORY');
} }
public function registerContainerConfiguration(LoaderInterface $loader) public function registerContainerConfiguration(LoaderInterface $loader)
diff --git a/app/config/config.yml b/app/config/config.yml
index 7f0a4ca6c..77b5175c8 100644
--- a/app/config/config.yml
+++ b/app/config/config.yml
@@ -1,5 +1,7 @@
imports:
- - { resource: parameters.yml }
+ # Unfortunately, we cannot use %env(string:CONFIGURATION_DIRECTORY)%. Hardcoding the path for simplicity.
+ # https://symfony.com/doc/current/service_container/import.html#importing-configuration-with-imports
+ - { resource: '/etc/wallabag/parameters.yml' }
- { resource: security.yml }
- { resource: services.yml }
- { resource: wallabag.yml }
@@ -28,7 +30,7 @@ framework:
session:
# handler_id set to null will use default session handler from php.ini
handler_id: session.handler.native_file
- save_path: "%kernel.project_dir%/var/sessions/%kernel.environment%"
+ save_path: "%env(string:CACHE_DIRECTORY)%/sessions/%kernel.environment%"
cookie_secure: auto
fragments: ~
http_method_override: true
diff --git a/app/config/wallabag.yml b/app/config/wallabag.yml
index bd57d6377..8e1cd0970 100644
--- a/app/config/wallabag.yml
+++ b/app/config/wallabag.yml
@@ -35,7 +35,7 @@ wallabag_core:
fetching_error_message: |
wallabag can't retrieve contents for this article. Please <a href="https://doc.wallabag.org/en/user/errors_during_fetching.html#how-can-i-help-to-fix-that">troubleshoot this issue</a>.
api_limit_mass_actions: 10
- encryption_key_path: "%kernel.project_dir%/data/site-credentials-secret-key.txt"
+ encryption_key_path: "%env(string:STATE_DIRECTORY)%/site-credentials-secret-key.txt"
default_internal_settings:
-
name: share_public

View file

@ -15,7 +15,7 @@
let let
pname = "wallabag"; pname = "wallabag";
version = "2.6.8"; version = "2.6.9";
in in
stdenv.mkDerivation { stdenv.mkDerivation {
inherit pname version; inherit pname version;
@ -23,7 +23,7 @@ stdenv.mkDerivation {
# Release tarball includes vendored files # Release tarball includes vendored files
src = fetchurl { src = fetchurl {
url = "https://github.com/wallabag/wallabag/releases/download/${version}/wallabag-${version}.tar.gz"; url = "https://github.com/wallabag/wallabag/releases/download/${version}/wallabag-${version}.tar.gz";
hash = "sha256-pmQXafqpd5rTwBIYG9NnwIIPta6Ek7iYaPaHvz1s550="; hash = "sha256-V4s5/y9fFAmZ+WnUxU03UyRivEihD1ZUKQOOq4TLEKw=";
}; };
patches = [ patches = [