├── docker-supervisord.conf ├── Dockerfile ├── .clang-format ├── .github └── workflows │ └── build.yml ├── docker-compose.yml ├── CMakeLists.txt ├── src ├── ThreadPool.h ├── Logger.h ├── ThreadPool.cpp ├── MQTT_Callbacks.h ├── MQTT_Callbacks.cpp ├── Logger.cpp └── main.cpp ├── docker-rsyslog.conf ├── .gitignore ├── README.md └── LICENSE /docker-supervisord.conf: -------------------------------------------------------------------------------- 1 | [supervisord] 2 | nodaemon=true 3 | 4 | [program:rsyslog] 5 | command=/usr/sbin/rsyslogd -n 6 | autostart=true 7 | autorestart=true 8 | 9 | [program:app] 10 | command=/usr/bin/remys_fast_mqtt_logger 11 | autostart=true 12 | autorestart=true 13 | stdout_logfile=/dev/stdout 14 | stdout_logfile_maxbytes=0 15 | redirect_stderr=true 16 | 17 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM gcc:14 2 | WORKDIR /app 3 | RUN apt-get update && apt-get install -y \ 4 | build-essential \ 5 | cmake \ 6 | bash \ 7 | libssl-dev \ 8 | libpaho-mqtt-dev \ 9 | libpaho-mqttpp-dev \ 10 | rsyslog \ 11 | supervisor \ 12 | mosquitto-clients \ 13 | && rm -rf /var/lib/apt/lists/* 14 | 15 | COPY docker-rsyslog.conf /etc/rsyslog.conf 16 | COPY docker-supervisord.conf /etc/supervisor/supervisord.conf 17 | 18 | COPY CMakeLists.txt /app/ 19 | COPY src /app/src 20 | 21 | RUN mkdir build && cd build \ 22 | && cmake -DCMAKE_BUILD_TYPE=Release .. \ 23 | && make \ 24 | && make install 25 | 26 | CMD ["/usr/bin/supervisord", "-c", "/etc/supervisor/supervisord.conf"] 27 | -------------------------------------------------------------------------------- /.clang-format: -------------------------------------------------------------------------------- 1 | BasedOnStyle: WebKit 2 | AccessModifierOffset: '-4' 3 | AllowShortFunctionsOnASingleLine: Inline 4 | AlwaysBreakTemplateDeclarations: 'true' 5 | BreakBeforeBraces: Custom 6 | BraceWrapping: 7 | AfterCaseLabel: true 8 | AfterClass: true 9 | AfterEnum: true 10 | AfterUnion: true 11 | AfterFunction: true 12 | AfterNamespace: true 13 | AfterStruct: true 14 | SplitEmptyFunction: false 15 | AfterControlStatement: Always 16 | BeforeCatch: true 17 | BeforeElse: true 18 | ColumnLimit: '0' 19 | Cpp11BracedListStyle: 'true' 20 | PointerAlignment: Right 21 | BreakConstructorInitializers: 'AfterColon' 22 | UseTab: 'Never' 23 | AlignAfterOpenBracket: 'AlwaysBreak' 24 | AllowShortBlocksOnASingleLine: 'true' 25 | -------------------------------------------------------------------------------- /.github/workflows/build.yml: -------------------------------------------------------------------------------- 1 | name: CI Workflow 2 | 3 | on: 4 | push: 5 | branches: 6 | - master 7 | pull_request: 8 | branches: 9 | - master 10 | 11 | jobs: 12 | build: 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - name: Checkout code 17 | uses: actions/checkout@v2 18 | 19 | - name: Build MQTT logger using CMake 20 | run: | 21 | sudo apt-get update 22 | sudo apt-get install -y \ 23 | build-essential \ 24 | cmake \ 25 | libpaho-mqtt-dev \ 26 | libpaho-mqttpp-dev \ 27 | mosquitto-clients 28 | mkdir build 29 | cd build 30 | cmake -DCMAKE_BUILD_TYPE=Release .. 31 | make 32 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | remys-fast-mqtt-logger: 3 | image: raymii/remys_fast_mqtt_logger:latest 4 | # or to build locally: 5 | # context: . 6 | # dockerfile: Dockerfile 7 | # set when using certificates: 8 | # volumes: 9 | # - /path/to/client.crt:/ssl/client.crt 10 | # - /path/to/client.key:/ssl/client.key 11 | # - /path/to/ca.crt:/ssl/ca.crt 12 | environment: 13 | - BROKER=tcp://test.mosquitto.org:1883 14 | #- USERNAME=user 15 | #- PASSWORD=pass 16 | #- TOPIC=home/temperature 17 | #- FACILITY=LOG_LOCAL6 18 | #- NO_LOG_TO_STDOUT=1 19 | #- CA_FILE=/ssl/ca.crt 20 | #- CLIENT_CERT=/ssl/client.crt 21 | #- CLIENT_KEY=/ssl/client.key 22 | #- CLIENT_KEY_PASSWORD=1234 23 | restart: unless-stopped 24 | -------------------------------------------------------------------------------- /CMakeLists.txt: -------------------------------------------------------------------------------- 1 | cmake_minimum_required(VERSION 3.11) 2 | 3 | project(remys_fast_mqtt_logger) 4 | 5 | set(CMAKE_CXX_STANDARD 17) 6 | set(CMAKE_CXX_STANDARD_REQUIRED True) 7 | set(CMAKE_CXX_FLAGS_RELEASE "-O2") 8 | set(CMAKE_CXX_FLAGS_DEBUG "-g -O0") 9 | 10 | find_package(Threads REQUIRED) 11 | 12 | include(CheckIncludeFile) 13 | check_include_file(syslog.h HAVE_SYSLOG) 14 | 15 | if(HAVE_SYSLOG) 16 | add_definitions(-DHAVE_SYSLOG) 17 | endif() 18 | 19 | add_executable(remys_fast_mqtt_logger src/main.cpp 20 | src/ThreadPool.cpp 21 | src/ThreadPool.h 22 | src/Logger.cpp 23 | src/Logger.h 24 | src/MQTT_Callbacks.cpp 25 | src/MQTT_Callbacks.h) 26 | 27 | target_link_libraries(remys_fast_mqtt_logger 28 | PRIVATE 29 | ${PAHO_MQTT_C_LIBRARIES} 30 | ${PAHO_MQTT_CPP_LIBRARIES} 31 | Threads::Threads 32 | paho-mqttpp3 33 | paho-mqtt3as 34 | ) 35 | 36 | install(TARGETS remys_fast_mqtt_logger 37 | RUNTIME DESTINATION /usr/bin 38 | ) -------------------------------------------------------------------------------- /src/ThreadPool.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | #pragma once 19 | 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | 28 | class ThreadPool { 29 | 30 | public: 31 | explicit ThreadPool(size_t thread_count); 32 | ~ThreadPool(); 33 | 34 | void enqueue(std::function task); 35 | 36 | private: 37 | std::vector _workers {}; 38 | std::queue> _task_queue; 39 | std::mutex _queue_mutex; 40 | std::condition_variable _cv; 41 | std::atomic _stop; 42 | 43 | void worker_thread(); 44 | }; 45 | 46 | -------------------------------------------------------------------------------- /src/Logger.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | #pragma once 19 | 20 | #include 21 | 22 | #ifdef HAVE_SYSLOG 23 | #include 24 | #else 25 | #define LOG_EMERG 0 /* system is unusable */ 26 | #define LOG_ALERT 1 /* action must be taken immediately */ 27 | #define LOG_CRIT 2 /* critical conditions */ 28 | #define LOG_ERR 3 /* error conditions */ 29 | #define LOG_WARNING 4 /* warning conditions */ 30 | #define LOG_NOTICE 5 /* normal but significant condition */ 31 | #define LOG_INFO 6 /* informational */ 32 | #define LOG_DEBUG 7 /* debug-level messages */ 33 | #endif 34 | 35 | 36 | class Logger { 37 | public: 38 | Logger(const char *ident, int facility, bool no_log_to_stderr); 39 | ~Logger(); 40 | 41 | void log(int priority, const char *format, ...) const __attribute__((format(printf, 3, 4))); 42 | static int getFacilityFromString(const std::string &facility); 43 | 44 | }; 45 | 46 | -------------------------------------------------------------------------------- /docker-rsyslog.conf: -------------------------------------------------------------------------------- 1 | # /etc/rsyslog.conf configuration file for rsyslog 2 | # 3 | # For more information install rsyslog-doc and see 4 | # /usr/share/doc/rsyslog-doc/html/configuration/index.html 5 | 6 | 7 | ################# 8 | #### MODULES #### 9 | ################# 10 | 11 | module(load="imuxsock") # provides support for local system logging 12 | module(load="imklog") # provides kernel logging support 13 | #module(load="immark") # provides --MARK-- message capability 14 | 15 | # provides UDP syslog reception 16 | module(load="imudp") 17 | input(type="imudp" port="514") 18 | 19 | # provides TCP syslog reception 20 | module(load="imtcp") 21 | input(type="imtcp" port="514") 22 | 23 | 24 | ########################### 25 | #### GLOBAL DIRECTIVES #### 26 | ########################### 27 | 28 | # 29 | # Set the default permissions for all log files. 30 | # 31 | $FileOwner root 32 | $FileGroup adm 33 | $FileCreateMode 0640 34 | $DirCreateMode 0755 35 | $Umask 0022 36 | 37 | # 38 | # Where to place spool and state files 39 | # 40 | $WorkDirectory /var/spool/rsyslog 41 | 42 | # 43 | # Include all config files in /etc/rsyslog.d/ 44 | # 45 | $IncludeConfig /etc/rsyslog.d/*.conf 46 | 47 | 48 | ############### 49 | #### RULES #### 50 | ############### 51 | 52 | # 53 | # Log anything besides private authentication messages to a single log file 54 | # 55 | *.*;auth,authpriv.none -/var/log/syslog 56 | 57 | # 58 | # Log commonly used facilities to their own log file 59 | # 60 | auth,authpriv.* /var/log/auth.log 61 | cron.* -/var/log/cron.log 62 | kern.* -/var/log/kern.log 63 | mail.* -/var/log/mail.log 64 | user.* -/var/log/user.log 65 | 66 | # 67 | # Emergencies are sent to everybody logged in. 68 | # 69 | *.emerg :omusrmsg:* 70 | 71 | 72 | # Forward logs to Logstash 73 | *.* @logstash:514 74 | -------------------------------------------------------------------------------- /src/ThreadPool.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | #include "ThreadPool.h" 19 | 20 | 21 | ThreadPool::ThreadPool(size_t thread_count) : 22 | _stop(false) 23 | { 24 | for (size_t i = 0; i < thread_count; ++i) 25 | { 26 | _workers.emplace_back(&ThreadPool::worker_thread, this); 27 | } 28 | } 29 | 30 | ThreadPool::~ThreadPool() 31 | { 32 | _stop = true; 33 | _cv.notify_all(); 34 | for (auto &thread: _workers) 35 | { 36 | if (thread.joinable()) 37 | { 38 | thread.join(); 39 | } 40 | } 41 | } 42 | 43 | void ThreadPool::enqueue(std::function task) 44 | { 45 | { 46 | std::lock_guard lock(_queue_mutex); 47 | _task_queue.push(std::move(task)); 48 | } 49 | _cv.notify_one(); 50 | } 51 | 52 | void ThreadPool::worker_thread() 53 | { 54 | while (!_stop) { 55 | std::function task; 56 | { 57 | std::unique_lock lock(_queue_mutex); 58 | _cv.wait(lock, [this] { 59 | return !_task_queue.empty() || _stop; 60 | }); 61 | if (_stop) 62 | return; 63 | 64 | task = std::move(_task_queue.front()); 65 | _task_queue.pop(); 66 | } 67 | 68 | task(); 69 | } 70 | } -------------------------------------------------------------------------------- /src/MQTT_Callbacks.h: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | #pragma once 19 | #include 20 | 21 | class ThreadPool; 22 | class Logger; 23 | 24 | 25 | class MQTT_Success_Failure_Logger : public virtual mqtt::iaction_listener 26 | { 27 | public: 28 | MQTT_Success_Failure_Logger(const std::string& name, Logger& logger) : 29 | _name(name), _logger(logger) 30 | { } 31 | 32 | void on_failure(const mqtt::token &tok) override; 33 | void on_success(const mqtt::token &tok) override; 34 | 35 | private: 36 | std::string _name; 37 | Logger& _logger; 38 | }; 39 | 40 | 41 | class MQTT_Callbacks : public virtual mqtt::callback, public virtual mqtt::iaction_listener { 42 | public: 43 | MQTT_Callbacks(mqtt::async_client& client, 44 | const std::string& topic, 45 | Logger& logger, 46 | ThreadPool& threadpool) : 47 | _client(client), _topic(topic), 48 | _logger(logger), _thread_pool(threadpool), 49 | _subLogger("Subscribe", _logger) 50 | { } 51 | 52 | void connected(const std::string &cause) override; 53 | void connection_lost(const std::string &cause) override; 54 | void on_failure(const mqtt::token &tok) override; 55 | void on_success(const mqtt::token&) override {}; 56 | void message_arrived(mqtt::const_message_ptr msg) override; 57 | 58 | private: 59 | mqtt::async_client& _client; 60 | std::string _topic; 61 | Logger& _logger; 62 | ThreadPool &_thread_pool; 63 | MQTT_Success_Failure_Logger _subLogger; 64 | }; -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # ---> C++ 2 | # Prerequisites 3 | *.d 4 | 5 | # Compiled Object files 6 | *.slo 7 | *.lo 8 | *.o 9 | *.obj 10 | 11 | # Precompiled Headers 12 | *.gch 13 | *.pch 14 | 15 | # Compiled Dynamic libraries 16 | *.so 17 | *.dylib 18 | *.dll 19 | 20 | # Fortran module files 21 | *.mod 22 | *.smod 23 | 24 | # Compiled Static libraries 25 | *.lai 26 | *.la 27 | *.a 28 | *.lib 29 | 30 | # Executables 31 | *.exe 32 | *.out 33 | *.app 34 | 35 | # ---> JetBrains 36 | # Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider 37 | # Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 38 | .idea/ 39 | # User-specific stuff 40 | .idea/**/workspace.xml 41 | .idea/**/tasks.xml 42 | .idea/**/usage.statistics.xml 43 | .idea/**/dictionaries 44 | .idea/**/shelf 45 | 46 | # AWS User-specific 47 | .idea/**/aws.xml 48 | 49 | # Generated files 50 | .idea/**/contentModel.xml 51 | 52 | # Sensitive or high-churn files 53 | .idea/**/dataSources/ 54 | .idea/**/dataSources.ids 55 | .idea/**/dataSources.local.xml 56 | .idea/**/sqlDataSources.xml 57 | .idea/**/dynamic.xml 58 | .idea/**/uiDesigner.xml 59 | .idea/**/dbnavigator.xml 60 | 61 | # Gradle 62 | .idea/**/gradle.xml 63 | .idea/**/libraries 64 | 65 | # Gradle and Maven with auto-import 66 | # When using Gradle or Maven with auto-import, you should exclude module files, 67 | # since they will be recreated, and may cause churn. Uncomment if using 68 | # auto-import. 69 | # .idea/artifacts 70 | # .idea/compiler.xml 71 | # .idea/jarRepositories.xml 72 | # .idea/modules.xml 73 | # .idea/*.iml 74 | # .idea/modules 75 | # *.iml 76 | # *.ipr 77 | 78 | # CMake 79 | cmake-build-*/ 80 | 81 | # Mongo Explorer plugin 82 | .idea/**/mongoSettings.xml 83 | 84 | # File-based project format 85 | *.iws 86 | 87 | # IntelliJ 88 | out/ 89 | 90 | # mpeltonen/sbt-idea plugin 91 | .idea_modules/ 92 | 93 | # JIRA plugin 94 | atlassian-ide-plugin.xml 95 | 96 | # Cursive Clojure plugin 97 | .idea/replstate.xml 98 | 99 | # SonarLint plugin 100 | .idea/sonarlint/ 101 | 102 | # Crashlytics plugin (for Android Studio and IntelliJ) 103 | com_crashlytics_export_strings.xml 104 | crashlytics.properties 105 | crashlytics-build.properties 106 | fabric.properties 107 | 108 | # Editor-based Rest Client 109 | .idea/httpRequests 110 | 111 | # Android studio 3.1+ serialized cache file 112 | .idea/caches/build_file_checksums.ser 113 | 114 | -------------------------------------------------------------------------------- /src/MQTT_Callbacks.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | 19 | #include "MQTT_Callbacks.h" 20 | #include "Logger.h" 21 | #include "ThreadPool.h" 22 | 23 | void MQTT_Success_Failure_Logger::on_failure(const mqtt::token& tok) 24 | { 25 | if (tok.get_message_id() != 0) 26 | _logger.log(LOG_ERR, "%s failure for token: [%i]\n", _name.c_str(), tok.get_message_id()); 27 | else 28 | _logger.log(LOG_ERR, "%s failure\n", _name.c_str()); 29 | } 30 | 31 | void MQTT_Success_Failure_Logger::on_success(const mqtt::token& tok) 32 | { 33 | if (tok.get_message_id() != 0) 34 | _logger.log(LOG_INFO, "%s success for token: [%i]\n", _name.c_str(), tok.get_message_id()); 35 | 36 | 37 | auto top = tok.get_topics(); 38 | if (top && !top->empty()) { 39 | _logger.log(LOG_INFO, "%s success for topic: [%s]\n", _name.c_str(), (*top)[0].c_str()); 40 | } 41 | } 42 | 43 | void MQTT_Callbacks::connected(const std::string& cause) 44 | { 45 | _logger.log(LOG_INFO, "Connected to MQTT broker '%s'\n", cause.c_str()); 46 | try { 47 | _logger.log(LOG_INFO, "Subscribing to topic '%s'\n", _topic.c_str()); 48 | _client.subscribe(_topic, 0, nullptr, _subLogger); 49 | } catch (const mqtt::exception &e) { 50 | _logger.log(LOG_ERR, "MQTT subscribe failed: %s\n", e.what()); 51 | } 52 | } 53 | 54 | void MQTT_Callbacks::connection_lost(const std::string& cause) 55 | { 56 | _logger.log(LOG_ERR, "MQTT connection lost: %s\n", cause.c_str()); 57 | } 58 | 59 | 60 | void MQTT_Callbacks::on_failure(const mqtt::token& ) 61 | { 62 | _logger.log(LOG_ERR, "MQTT connection attempt failed\n"); 63 | } 64 | 65 | 66 | void MQTT_Callbacks::message_arrived(mqtt::const_message_ptr msg) 67 | { 68 | if (msg != nullptr) { 69 | _thread_pool.enqueue([this, msg] { 70 | _logger.log(LOG_INFO, "topic='%s', qos='%i', retained='%s', msg='%s'", 71 | msg->get_topic().c_str(), msg->get_qos(), 72 | msg->is_retained() ? "true" : "false", 73 | msg->get_payload_ref().c_str()); 74 | }); 75 | } 76 | } 77 | -------------------------------------------------------------------------------- /src/Logger.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | #include "Logger.h" 19 | 20 | #include 21 | #include 22 | #include 23 | 24 | #ifdef HAVE_SYSLOG 25 | #include 26 | #endif 27 | 28 | 29 | Logger::Logger(const char *ident, int facility, bool no_log_to_stderr) 30 | { 31 | #ifdef HAVE_SYSLOG 32 | int log_options = LOG_PID | LOG_CONS; 33 | if (!no_log_to_stderr) { 34 | log_options |= LOG_PERROR; 35 | } 36 | openlog(ident, log_options, facility); 37 | #else 38 | (void)ident; 39 | (void)facility; 40 | (void)no_log_to_stderr; 41 | #endif 42 | } 43 | 44 | Logger::~Logger() { 45 | #ifdef HAVE_SYSLOG 46 | closelog(); 47 | #endif 48 | } 49 | 50 | void Logger::log(int priority, const char *format, ...) const 51 | { 52 | #ifdef HAVE_SYSLOG 53 | va_list args; 54 | va_start(args, format); 55 | vsyslog(priority, format, args); 56 | va_end(args); 57 | #else 58 | auto now = std::chrono::system_clock::now(); 59 | auto now_time_t = std::chrono::system_clock::to_time_t(now); 60 | auto now_us = std::chrono::duration_cast(now.time_since_epoch()) % 1000000; 61 | 62 | std::tm now_tm = *std::localtime(&now_time_t); 63 | 64 | printf("%04d-%02d-%02d %02d:%02d:%02d.%06ld ", 65 | now_tm.tm_year + 1900, 66 | now_tm.tm_mon + 1, 67 | now_tm.tm_mday, 68 | now_tm.tm_hour, 69 | now_tm.tm_min, 70 | now_tm.tm_sec, 71 | now_us.count()); 72 | 73 | va_list args; 74 | va_start(args, format); 75 | vprintf(format, args); 76 | va_end(args); 77 | printf("\n"); 78 | #endif 79 | } 80 | 81 | 82 | int Logger::getFacilityFromString(const std::string &facility) { 83 | static const std::map facilityMap = { 84 | #ifdef HAVE_SYSLOG 85 | {"LOG_AUTH", LOG_AUTH}, 86 | {"LOG_AUTHPRIV", LOG_AUTHPRIV}, 87 | {"LOG_CRON", LOG_CRON}, 88 | {"LOG_DAEMON", LOG_DAEMON}, 89 | {"LOG_FTP", LOG_FTP}, 90 | {"LOG_KERN", LOG_KERN}, 91 | {"LOG_LPR", LOG_LPR}, 92 | {"LOG_MAIL", LOG_MAIL}, 93 | {"LOG_NEWS", LOG_NEWS}, 94 | {"LOG_SYSLOG", LOG_SYSLOG}, 95 | {"LOG_USER", LOG_USER}, 96 | {"LOG_UUCP", LOG_UUCP}, 97 | {"LOG_LOCAL0", LOG_LOCAL0}, 98 | {"LOG_LOCAL1", LOG_LOCAL1}, 99 | {"LOG_LOCAL2", LOG_LOCAL2}, 100 | {"LOG_LOCAL3", LOG_LOCAL3}, 101 | {"LOG_LOCAL4", LOG_LOCAL4}, 102 | {"LOG_LOCAL5", LOG_LOCAL5}, 103 | {"LOG_LOCAL6", LOG_LOCAL6}, 104 | {"LOG_LOCAL7", LOG_LOCAL7} 105 | #endif 106 | }; 107 | 108 | auto it = facilityMap.find(facility); 109 | return (it != facilityMap.end()) ? it->second : -1; 110 | } -------------------------------------------------------------------------------- /src/main.cpp: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c) 2025 Remy van Elst 3 | * 4 | * This program is free software: you can redistribute it and/or modify 5 | * it under the terms of the GNU Afferro General Public License as published by 6 | * the Free Software Foundation, version 3. 7 | * 8 | * This program is distributed in the hope that it will be useful, but 9 | * WITHOUT ANY WARRANTY; without even the implied warranty of 10 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 11 | * General Public License for more details. 12 | * 13 | * You should have received a copy of the GNU General Public License 14 | * along with this program. If not, see . 15 | * 16 | */ 17 | 18 | #include 19 | #include 20 | #include 21 | #include 22 | #include 23 | #include 24 | #include 25 | #include 26 | #include 27 | using namespace std::chrono_literals; 28 | 29 | 30 | #include "Logger.h" 31 | #include "MQTT_Callbacks.h" 32 | #include "ThreadPool.h" 33 | 34 | const char* argp_program_name = "Remys Fast MQTT Logger"; 35 | const char* argp_program_version = "1.1"; 36 | const char* argp_program_bug_address = ""; 37 | 38 | struct cli_arguments 39 | { 40 | std::string broker, username, password; 41 | std::string topic = "#"; 42 | std::string facility = "LOG_LOCAL6"; 43 | bool no_log_to_stderr = false; 44 | std::string ca_file, client_cert, client_key, client_key_password; 45 | }; 46 | 47 | static char doc[] = "MQTT client that connects to a broker, " 48 | "subscribes to $TOPIC and logs messages " 49 | "to syslog $FACILITY, and if asked, to stdout. " 50 | "Assumes strings, not binary payload. " 51 | "Options can also be set as ENV vars "; 52 | 53 | static argp_option options[] = { 54 | {"broker", 'b', "BROKER", 0, "MQTT broker URL:port"}, 55 | {"topic", 't', "TOPIC", 0, "Topic to subscribe (default: #)"}, 56 | {"username", 'u', "USERNAME", OPTION_ARG_OPTIONAL, "Username for MQTT broker (optional)"}, 57 | {"password", 'p', "PASSWORD", OPTION_ARG_OPTIONAL, "Password for MQTT broker (optional)"}, 58 | {"facility", 'f', "FACILITY", 0, "Syslog facility to log to (default: LOG_LOCAL6). Must prefix with LOG_"}, 59 | { 60 | "no-log-to-stderr", 's', "NO_LOG_TO_STDERR", OPTION_ARG_OPTIONAL, 61 | "Disabled message logging to STDERR. (Default: enabled)" 62 | }, 63 | {"ca-file", 'A', "CA_FILE", OPTION_ARG_OPTIONAL, "CA certificate file (optional)"}, 64 | {"client-cert", 'C', "CLIENT_CERT", OPTION_ARG_OPTIONAL, "Client certificate file (optional)"}, 65 | {"client-key", 'K', "CLIENT_KEY", OPTION_ARG_OPTIONAL, "Client private key file (optional)"}, 66 | {"client-key-password", 'P', "CLIENT_KEY_PASSWORD", OPTION_ARG_OPTIONAL, "Client private key password (optional)"}, 67 | {nullptr} 68 | }; 69 | 70 | static error_t parse_opt(int key, char* arg, argp_state* state) 71 | { 72 | auto* arguments = static_cast(state->input); 73 | switch (key) 74 | { 75 | case 'b': 76 | if (arg) arguments->broker = arg; 77 | break; 78 | case 't': 79 | if (arg) arguments->topic = arg; 80 | break; 81 | case 'u': 82 | if (arg) arguments->username = arg; 83 | break; 84 | case 'p': 85 | if (arg) arguments->password = arg; 86 | break; 87 | case 'f': 88 | if (arg) arguments->facility = arg; 89 | break; 90 | case 's': 91 | if (arg) arguments->no_log_to_stderr = true; 92 | break; 93 | case 'A': 94 | if (arg) arguments->ca_file = arg; 95 | break; 96 | case 'C': 97 | if (arg) arguments->client_cert = arg; 98 | break; 99 | case 'K': 100 | if (arg) arguments->client_key = arg; 101 | break; 102 | case 'P': 103 | if (arg) arguments->client_key_password = arg; 104 | break; 105 | case ARGP_KEY_END: 106 | if (arguments->broker.empty()) 107 | { 108 | argp_usage(state); 109 | } 110 | break; 111 | default: 112 | return ARGP_ERR_UNKNOWN; 113 | } 114 | return 0; 115 | } 116 | 117 | static argp argp = {options, parse_opt, nullptr, doc}; 118 | 119 | std::mutex stop_mtx; 120 | std::condition_variable stop_cv; 121 | bool stop_signal_received = false; 122 | 123 | void signal_handler(int signal) 124 | { 125 | if (signal == SIGINT || signal == SIGTERM) 126 | { 127 | stop_signal_received = true; 128 | stop_cv.notify_one(); 129 | } 130 | } 131 | 132 | int main(int argc, char* argv[]) 133 | { 134 | cli_arguments arguments; 135 | 136 | size_t env_arg_count = 0; 137 | if (const char* env_p = std::getenv("BROKER")) 138 | { 139 | arguments.broker = env_p; 140 | env_arg_count++; 141 | } 142 | 143 | if (const char* env_p = std::getenv("USERNAME")) 144 | { 145 | arguments.username = env_p; 146 | env_arg_count++; 147 | } 148 | 149 | if (const char* env_p = std::getenv("PASSWORD")) 150 | { 151 | arguments.password = env_p; 152 | env_arg_count++; 153 | } 154 | 155 | if (const char* env_p = std::getenv("TOPIC")) 156 | { 157 | arguments.topic = env_p; 158 | env_arg_count++; 159 | } 160 | 161 | if (const char* env_p = std::getenv("FACILITY")) 162 | { 163 | arguments.facility = env_p; 164 | env_arg_count++; 165 | } 166 | 167 | if (const char* env_p = std::getenv("CA_FILE")) 168 | { 169 | arguments.ca_file = env_p; 170 | env_arg_count++; 171 | } 172 | 173 | if (const char* env_p = std::getenv("CLIENT_CERT")) 174 | { 175 | arguments.client_cert = env_p; 176 | env_arg_count++; 177 | } 178 | 179 | if (const char* env_p = std::getenv("CLIENT_KEY")) 180 | { 181 | arguments.client_key = env_p; 182 | env_arg_count++; 183 | } 184 | 185 | if (const char* env_p = std::getenv("CLIENT_KEY_PASSWORD")) 186 | { 187 | arguments.client_key_password = env_p; 188 | env_arg_count++; 189 | } 190 | 191 | if (const char* env_p = std::getenv("NO_LOG_TO_STDERR")) 192 | { 193 | arguments.no_log_to_stderr = std::string(env_p) == "1"; 194 | env_arg_count++; 195 | } 196 | 197 | if (env_arg_count == 0) 198 | { 199 | if (argp_parse(&argp, argc, argv, 0, nullptr, &arguments) != 0) 200 | { 201 | std::cerr << "Failed to parse arguments;\n"; 202 | exit(1); 203 | } 204 | } 205 | 206 | if (arguments.broker.empty()) 207 | { 208 | std::cerr << "Not enough arguments. Use --help.\n"; 209 | exit(1); 210 | } 211 | 212 | 213 | ThreadPool thread_pool(std::thread::hardware_concurrency()); 214 | 215 | auto syslogFacility = Logger::getFacilityFromString(arguments.facility); 216 | Logger logger = Logger(argp_program_name, syslogFacility, arguments.no_log_to_stderr); 217 | 218 | logger.log(LOG_INFO, "Started Remys Fast MQTT Logger by Remy van Elst, raymii.org, AGPLv3\n"); 219 | 220 | std::signal(SIGINT, signal_handler); 221 | std::signal(SIGTERM, signal_handler); 222 | 223 | #ifndef HAVE_SYSLOG 224 | fprintf(stderr, "\n not found. Only printing to STDOUT!\n"); 225 | #endif 226 | 227 | // large buffer size to combat: MQTT error [-12]: No more messages can be buffered 228 | mqtt::async_client client(arguments.broker, "", std::numeric_limits::max()); 229 | 230 | auto connOpts = mqtt::connect_options_builder() 231 | .automatic_reconnect(1s, 2s) 232 | .connect_timeout(30s) 233 | .keep_alive_interval(5s) 234 | .clean_session(true).finalize(); 235 | 236 | if (!arguments.username.empty()) 237 | { 238 | connOpts.set_user_name(arguments.username); 239 | } 240 | if (!arguments.password.empty()) 241 | { 242 | connOpts.set_password(arguments.password); 243 | } 244 | 245 | if (!arguments.client_cert.empty() && !arguments.client_key.empty() && !arguments.ca_file.empty()) 246 | { 247 | mqtt::ssl_options sslOpts; 248 | logger.log(LOG_INFO, "Setting client certificate to %s...", arguments.client_cert.c_str()); 249 | sslOpts.set_key_store(arguments.client_cert); 250 | logger.log(LOG_INFO, "Setting client key to %s...", arguments.client_key.c_str()); 251 | sslOpts.set_private_key(arguments.client_key); 252 | logger.log(LOG_INFO, "Setting ca file to %s...", arguments.ca_file.c_str()); 253 | sslOpts.set_trust_store(arguments.ca_file); 254 | 255 | if (!arguments.client_key_password.empty()) 256 | { 257 | sslOpts.set_private_key_password(arguments.client_key_password); 258 | logger.log(LOG_INFO, "Setting client key password..."); 259 | } 260 | 261 | connOpts.set_ssl(sslOpts); 262 | } 263 | 264 | MQTT_Callbacks cb(client, arguments.topic, logger, thread_pool); 265 | client.set_callback(cb); 266 | 267 | try 268 | { 269 | if (!client.connect(connOpts)->wait_for(30000)) 270 | { 271 | logger.log(LOG_ERR, "\nTimeout Connecting\n"); 272 | exit(1); 273 | } 274 | } 275 | catch (const std::exception& e) 276 | { 277 | logger.log(LOG_ERR, "Error Connecting: %s\n", e.what()); 278 | exit(1); 279 | } 280 | 281 | 282 | std::unique_lock lock(stop_mtx); 283 | stop_cv.wait(lock, [] { return stop_signal_received; }); 284 | 285 | client.disconnect()->wait(); 286 | logger.log(LOG_INFO, "Stopping Remys Fast MQTT Logger by Remy van Elst, raymii.org, AGPLv3\n"); 287 | return 0; 288 | } 289 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Remy's Fast MQTT Logger 2 | 3 | **Remy's Fast MQTT Logger** is a C++ 17 application that connects 4 | to an MQTT broker, subscribes to a topic, 5 | and logs messages received from the broker 6 | to **syslog** (with configurable facility) and 7 | optionally to **stdout**. 8 | 9 | Connection failures are handled with automatic reconnect. 10 | 11 | Every message is logged on a separate thread in a thread pool, 12 | which is what makes is fast and able to process 13 | thousands of messages per second. Using Pipe Viewer 14 | to measure lines per second from a test broker: 15 | 16 | $ ./remys_fast_mqtt_logger -b test.mosquitto.org:1883 | pv --line-mode --rate --average-rate >/dev/null 17 | [4.79k/s] (3.35k/s) 18 | 19 | This is similar to `mosquitto_sub`: 20 | 21 | $ mosquitto_sub -h test.mosquitto.org -p 1883 -t "#" | pv --line-mode --rate --average-rate >/dev/null 22 | [3.39k/s] (3.37k/s) 23 | 24 | It is designed for use cases where logging MQTT 25 | message data needs to be centralized or handled 26 | by a logging service like **syslog**. 27 | 28 | It is cross-platform, meaning that if you don't have 29 | `syslog.h`, it will also compile and run, but it only 30 | prints to STDOUT. 31 | 32 | ## Features 33 | - Connects to an MQTT broker with user authentication (username and password). 34 | - Connects to an MQTT broker using client certificates. 35 | - Subscribes to a topic (`#` by default, can be customized via argument). 36 | - Logs received MQTT messages to **syslog** with customizable log **facility**. 37 | - Optionally logs messages to **stdout**. 38 | 39 | ## Dependencies 40 | The following libraries are required to build and 41 | run the application: 42 | 43 | 1. `PAHO MQTT C++ Client`: The application uses the [Paho MQTT C++ library](https://www.eclipse.org/paho/). 44 | 2. `syslog.h`: For logging messages to **syslog**. 45 | 46 | 47 | ### Building 48 | **Install dependencies**: 49 | 50 | - On **Ubuntu/Debian**: 51 | 52 | ```bash 53 | sudo apt install libpaho-mqttpp3-dev libsyslog-dev build-essential 54 | ``` 55 | - On **RedHat/CentOS**: 56 | 57 | ```bash 58 | sudo yum install paho-mqtt-c++ syslog-devel gcc-c++ make 59 | ``` 60 | 61 | **Clone or download the repository**: 62 | - Clone the repository from GitHub or download the source code to your local system. 63 | 64 | **Build the application**: 65 | 66 | To compile the application, use CMake: 67 | 68 | cd remys_fast_mqtt_logger 69 | mkdir build 70 | cd build 71 | cmake -DCMAKE_BUILD_TYPE=Release .. 72 | 73 | 74 | ## Usage 75 | 76 | The binary accepts the following arguments: 77 | 78 | ```bash 79 | remys_fast_mqtt_logger [OPTIONS] 80 | ``` 81 | 82 | ### Options: 83 | 84 | The program can be configured with command line 85 | options or ENVIRONMENT variables. The latter don't end up 86 | in your shell history. 87 | 88 | #### Command line arguments 89 | 90 | - `-b BROKER, --broker=BROKER` 91 | - The MQTT broker URL (including the port) to connect to. 92 | - Example: `tcp://test.mosquitto.org:1883`. 93 | - Example: `ssl://test.mosquitto.org:8883`. 94 | 95 | - `-t TOPIC, --topic=TOPIC` 96 | - The MQTT topic to subscribe to. 97 | - Default is `#` (subscribe to all topics). 98 | 99 | - `-u USERNAME, --username=USERNAME` 100 | - Username for authenticating with the MQTT broker. (optional) 101 | 102 | - `-p PASSWORD, --password=PASSWORD` 103 | - Password for authenticating with the MQTT broker. (optional) 104 | 105 | - `-f FACILITY, --facility=FACILITY` 106 | - The syslog facility to log to. Must prefix with `LOG_`. 107 | - Default is `LOG_LOCAL6`. 108 | 109 | - `-s, --no-log-to-stderr` 110 | - Disable logging to STDERR 111 | - Default is **disabled**, meaning messages will be logged to both **stderr** and **syslog** unless specified. 112 | 113 | - `-A, --ca-file` 114 | - Path to CA file that authenticates the broker to the client (optional) 115 | 116 | - `-C, --client-cert` 117 | - Path to client certificate file (optional) 118 | 119 | - `-K, --client-key` 120 | - Path to client key file (optional) 121 | 122 | - `-P, --client-key-password` 123 | - Password for client key file (optional). 124 | - If not provided but key has a password, you will be asked interactively on CLI. 125 | 126 | If any of `--ca-file`, `--client-cert` or `--client-key` is given, 127 | all three must be provided. 128 | 129 | 130 | 131 | #### Environment Variables 132 | 133 | You can configure the application using the following 134 | environment variables: 135 | 136 | - `BROKER`: MQTT broker URL (e.g., mqtt.example.com:1883). 137 | - `USERNAME`: MQTT username. 138 | - `PASSWORD`: MQTT password. 139 | - `TOPIC`: MQTT topic to subscribe to (default: #). 140 | - `FACILITY`: Syslog facility (default: LOG_LOCAL6). 141 | - `NO_LOG_TO_STDERR`: Disable logging to STDERR (default: on) 142 | - `CA_FILE`: Path to CA file that authenticates the broker to the client 143 | - `CLIENT_CERT`: Path to client certificate file 144 | - `CLIENT_KEY`: Path to client key file 145 | - `CLIENT_KEY_PASSWORD`: Password for client key file 146 | 147 | ### Example Commands: 148 | 149 | **Basic usage**: 150 | 151 | ```bash 152 | ./remys_fast_mqtt_logger -b "mqtt.example.com:1883" \ 153 | -t "home/livingroom/temperature" \ 154 | -u "user" \ 155 | -p "password" 156 | ``` 157 | 158 | **Log to a specific syslog facility**: 159 | 160 | ```bash 161 | ./remys_fast_mqtt_logger -b "mqtt.example.com:1883" \ 162 | -t "home/livingroom/temperature" \ 163 | -u "user" \ 164 | -p "password" \ 165 | -f "LOG_INFO" 166 | ``` 167 | 168 | **Disable logging to stdout**: 169 | 170 | ```bash 171 | ./remys_fast_mqtt_logger -b "mqtt.example.com:1883" \ 172 | -t "home/livingroom/temperature" \ 173 | -u "user" \ 174 | -p "password" \ 175 | -s 176 | ``` 177 | 178 | 179 | ### Syslog Facilities 180 | By default, logs are written to the **`LOG_LOCAL6`** facility. 181 | You can change this using the `-f` argument. 182 | 183 | Below is a list of valid syslog facilities that can be used: 184 | 185 | - `LOG_AUTH` 186 | - `LOG_AUTHPRIV` 187 | - `LOG_CRON` 188 | - `LOG_DAEMON` 189 | - `LOG_FTP` 190 | - `LOG_KERN` 191 | - `LOG_LPR` 192 | - `LOG_MAIL` 193 | - `LOG_NEWS` 194 | - `LOG_SYSLOG` 195 | - `LOG_USER` 196 | - `LOG_UUCP` 197 | - `LOG_LOCAL0` 198 | - `LOG_LOCAL1` 199 | - `LOG_LOCAL2` 200 | - `LOG_LOCAL3` 201 | - `LOG_LOCAL4` 202 | - `LOG_LOCAL5` 203 | - `LOG_LOCAL6` (default) 204 | - `LOG_LOCAL7` 205 | 206 | 207 | ### Example of Viewing Logs in Syslog: 208 | To view logs for `LOG_LOCAL6` in **syslog** or **journalctl**: 209 | 210 | ```bash 211 | journalctl SYSLOG_FACILITY=22 212 | ``` 213 | 214 | Or to view logs directly in **syslog**: 215 | 216 | ```bash 217 | tail -f /var/log/syslog 218 | ``` 219 | 220 | ### rsyslog and logrotate config 221 | 222 | You can save logs to `/var/log/mqtt_msgs.log` if you have configured **rsyslog** accordingly: 223 | 224 | sudo nano /etc/rsyslog.d/30-local6.conf 225 | 226 | Add: 227 | 228 | local6.* /var/log/mqtt_msgs.log 229 | 230 | Then: 231 | 232 | sudo touch /var/log/mqtt_msgs.log 233 | sudo chmod 644 /var/log/mqtt_msgs.log 234 | sudo chown syslog:adm /var/log/mqtt_msgs.log 235 | 236 | 237 | Configure `logrotate` to not delete these logs: 238 | 239 | sudo nano /etc/logrotate.d/remys_fast_mqtt_logger 240 | 241 | Contents: 242 | 243 | /var/log/mqtt_msgs.log { 244 | missingok 245 | notifempty 246 | size 100M 247 | rotate 9999 248 | compress 249 | delaycompress 250 | create 0644 root root 251 | sharedscripts 252 | postrotate 253 | systemctl reload rsyslog > /dev/null 2>&1 || true 254 | endscript 255 | } 256 | 257 | 258 | ## Build and Run with Docker 259 | 260 | To build and run the application with Docker, 261 | use the following commands inside the git checkout. 262 | 263 | Build the Docker image: 264 | 265 | docker build -t mqtt-logger . 266 | 267 | Or, use my image and run the Docker container: 268 | 269 | docker run -d --name remys_fast_mqtt_logger --env BROKER=test.mosquitto.org raymii/remys_fast_mqtt_logger:latest 270 | docker logs -f remys_fast_mqtt_logger 271 | 272 | There is also a `docker-compose.yml` file included 273 | which you can edit and use: 274 | 275 | docker compose up -d 276 | docker compose logs -f 277 | 278 | 279 | [+] Running 1/1 280 | ✔ Container mqtt_logger-remys-fast-mqtt-logger-1 Created0.0s 281 | Attaching to remys-fast-mqtt-logger-1 282 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/current', qos='0', retained='true', msg='1.87' 283 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/efficiency', qos='0', retained='true', msg='95.015' 284 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/frequency', qos='0', retained='true', msg='49.96' 285 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/power', qos='0', retained='true', msg='442.2' 286 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/powerfactor', qos='0', retained='true', msg='0.999' 287 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/temperature', qos='0', retained='true', msg='28.6' 288 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/voltage', qos='0', retained='true', msg='236.3' 289 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/yieldday', qos='0', retained='true', msg='5547' 290 | remys-fast-mqtt-logger-1 | topic='/116484256345/0/reactivepower', qos='0', retained='true', msg='0.3' 291 | remys-fast-mqtt-logger-1 | topic='SHRDZM/483FDA46C2EE/483FDA46C2EE/sensor', qos='0', retained='false', msg='{ 292 | remys-fast-mqtt-logger-1 | "lasterror":"cipherkey not set!", 293 | Gracefully stopping... (press Ctrl+C again to force) 294 | [+] Stopping 1/1 295 | 296 | 297 | ## License 298 | 299 | This project is licensed under the GNU AGPLv3 License. 300 | See the [LICENSE](LICENSE) file for more details. 301 | 302 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | 6 | Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU Affero General Public License is a free, copyleft license for software and other kinds of works, specifically designed to ensure cooperation with the community in the case of network server software. 11 | 12 | The licenses for most software and other practical works are designed to take away your freedom to share and change the works. By contrast, our General Public Licenses are intended to guarantee your freedom to share and change all versions of a program--to make sure it remains free software for all its users. 13 | 14 | When we speak of free software, we are referring to freedom, not price. Our General Public Licenses are designed to make sure that you have the freedom to distribute copies of free software (and charge for them if you wish), that you receive source code or can get it if you want it, that you can change the software or use pieces of it in new free programs, and that you know you can do these things. 15 | 16 | Developers that use our General Public Licenses protect your rights with two steps: (1) assert copyright on the software, and (2) offer you this License which gives you legal permission to copy, distribute and/or modify the software. 17 | 18 | A secondary benefit of defending all users' freedom is that improvements made in alternate versions of the program, if they receive widespread use, become available for other developers to incorporate. Many developers of free software are heartened and encouraged by the resulting cooperation. However, in the case of software used on network servers, this result may fail to come about. The GNU General Public License permits making a modified version and letting the public access it on a server without ever releasing its source code to the public. 19 | 20 | The GNU Affero General Public License is designed specifically to ensure that, in such cases, the modified source code becomes available to the community. It requires the operator of a network server to provide the source code of the modified version running there to the users of that server. Therefore, public use of a modified version, on a publicly accessible server, gives the public access to the source code of the modified version. 21 | 22 | An older license, called the Affero General Public License and published by Affero, was designed to accomplish similar goals. This is a different license, not a version of the Affero GPL, but Affero has released a new version of the Affero GPL which permits relicensing under this license. 23 | 24 | The precise terms and conditions for copying, distribution and modification follow. 25 | 26 | TERMS AND CONDITIONS 27 | 28 | 0. Definitions. 29 | 30 | "This License" refers to version 3 of the GNU Affero General Public License. 31 | 32 | "Copyright" also means copyright-like laws that apply to other kinds of works, such as semiconductor masks. 33 | 34 | "The Program" refers to any copyrightable work licensed under this License. Each licensee is addressed as "you". "Licensees" and "recipients" may be individuals or organizations. 35 | 36 | To "modify" a work means to copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy. The resulting work is called a "modified version" of the earlier work or a work "based on" the earlier work. 37 | 38 | A "covered work" means either the unmodified Program or a work based on the Program. 39 | 40 | To "propagate" a work means to do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy. Propagation includes copying, distribution (with or without modification), making available to the public, and in some countries other activities as well. 41 | 42 | To "convey" a work means any kind of propagation that enables other parties to make or receive copies. Mere interaction with a user through a computer network, with no transfer of a copy, is not conveying. 43 | 44 | An interactive user interface displays "Appropriate Legal Notices" to the extent that it includes a convenient and prominently visible feature that (1) displays an appropriate copyright notice, and (2) tells the user that there is no warranty for the work (except to the extent that warranties are provided), that licensees may convey the work under this License, and how to view a copy of this License. If the interface presents a list of user commands or options, such as a menu, a prominent item in the list meets this criterion. 45 | 46 | 1. Source Code. 47 | The "source code" for a work means the preferred form of the work for making modifications to it. "Object code" means any non-source form of a work. 48 | 49 | A "Standard Interface" means an interface that either is an official standard defined by a recognized standards body, or, in the case of interfaces specified for a particular programming language, one that is widely used among developers working in that language. 50 | 51 | The "System Libraries" of an executable work include anything, other than the work as a whole, that (a) is included in the normal form of packaging a Major Component, but which is not part of that Major Component, and (b) serves only to enable use of the work with that Major Component, or to implement a Standard Interface for which an implementation is available to the public in source code form. A "Major Component", in this context, means a major essential component (kernel, window system, and so on) of the specific operating system (if any) on which the executable work runs, or a compiler used to produce the work, or an object code interpreter used to run it. 52 | 53 | The "Corresponding Source" for a work in object code form means all the source code needed to generate, install, and (for an executable work) run the object code and to modify the work, including scripts to control those activities. However, it does not include the work's System Libraries, or general-purpose tools or generally available free programs which are used unmodified in performing those activities but which are not part of the work. For example, Corresponding Source includes interface definition files associated with source files for the work, and the source code for shared libraries and dynamically linked subprograms that the work is specifically designed to require, such as by intimate data communication or control flow between those 54 | subprograms and other parts of the work. 55 | 56 | The Corresponding Source need not include anything that users can regenerate automatically from other parts of the Corresponding Source. 57 | 58 | The Corresponding Source for a work in source code form is that same work. 59 | 60 | 2. Basic Permissions. 61 | All rights granted under this License are granted for the term of copyright on the Program, and are irrevocable provided the stated conditions are met. This License explicitly affirms your unlimited permission to run the unmodified Program. The output from running a covered work is covered by this License only if the output, given its content, constitutes a covered work. This License acknowledges your rights of fair use or other equivalent, as provided by copyright law. 62 | 63 | You may make, run and propagate covered works that you do not convey, without conditions so long as your license otherwise remains in force. You may convey covered works to others for the sole purpose of having them make modifications exclusively for you, or provide you with facilities for running those works, provided that you comply with the terms of this License in conveying all material for which you do not control copyright. Those thus making or running the covered works for you must do so exclusively on your behalf, under your direction and control, on terms that prohibit them from making any copies of your copyrighted material outside their relationship with you. 64 | 65 | Conveying under any other circumstances is permitted solely under the conditions stated below. Sublicensing is not allowed; section 10 makes it unnecessary. 66 | 67 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 68 | No covered work shall be deemed part of an effective technological measure under any applicable law fulfilling obligations under article 11 of the WIPO copyright treaty adopted on 20 December 1996, or similar laws prohibiting or restricting circumvention of such measures. 69 | 70 | When you convey a covered work, you waive any legal power to forbid circumvention of technological measures to the extent such circumvention is effected by exercising rights under this License with respect to the covered work, and you disclaim any intention to limit operation or modification of the work as a means of enforcing, against the work's users, your or third parties' legal rights to forbid circumvention of technological measures. 71 | 72 | 4. Conveying Verbatim Copies. 73 | You may convey verbatim copies of the Program's source code as you receive it, in any medium, provided that you conspicuously and appropriately publish on each copy an appropriate copyright notice; keep intact all notices stating that this License and any non-permissive terms added in accord with section 7 apply to the code; keep intact all notices of the absence of any warranty; and give all recipients a copy of this License along with the Program. 74 | 75 | You may charge any price or no price for each copy that you convey, and you may offer support or warranty protection for a fee. 76 | 77 | 5. Conveying Modified Source Versions. 78 | You may convey a work based on the Program, or the modifications to produce it from the Program, in the form of source code under the terms of section 4, provided that you also meet all of these conditions: 79 | 80 | a) The work must carry prominent notices stating that you modified it, and giving a relevant date. 81 | 82 | b) The work must carry prominent notices stating that it is released under this License and any conditions added under section 7. This requirement modifies the requirement in section 4 to "keep intact all notices". 83 | 84 | c) You must license the entire work, as a whole, under this License to anyone who comes into possession of a copy. This License will therefore apply, along with any applicable section 7 additional terms, to the whole of the work, and all its parts, regardless of how they are packaged. This License gives no permission to license the work in any other way, but it does not invalidate such permission if you have separately received it. 85 | 86 | d) If the work has interactive user interfaces, each must display Appropriate Legal Notices; however, if the Program has interactive interfaces that do not display Appropriate Legal Notices, your work need not make them do so. 87 | 88 | A compilation of a covered work with other separate and independent works, which are not by their nature extensions of the covered work, and which are not combined with it such as to form a larger program, in or on a volume of a storage or distribution medium, is called an "aggregate" if the compilation and its resulting copyright are not used to limit the access or legal rights of the compilation's users beyond what the individual works permit. Inclusion of a covered work in an aggregate does not cause this License to apply to the other parts of the aggregate. 89 | 90 | 6. Conveying Non-Source Forms. 91 | You may convey a covered work in object code form under the terms of sections 4 and 5, provided that you also convey the machine-readable Corresponding Source under the terms of this License, in one of these ways: 92 | 93 | a) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by the Corresponding Source fixed on a durable physical medium customarily used for software interchange. 94 | 95 | b) Convey the object code in, or embodied in, a physical product (including a physical distribution medium), accompanied by a written offer, valid for at least three years and valid for as long as you offer spare parts or customer support for that product model, to give anyone who possesses the object code either (1) a copy of the Corresponding Source for all the software in the product that is covered by this License, on a durable physical medium customarily used for software interchange, for a price no more than your reasonable cost of physically performing this conveying of source, or (2) access to copy the Corresponding Source from a network server at no charge. 96 | 97 | c) Convey individual copies of the object code with a copy of the written offer to provide the Corresponding Source. This alternative is allowed only occasionally and noncommercially, and only if you received the object code with such an offer, in accord with subsection 6b. 98 | 99 | d) Convey the object code by offering access from a designated place (gratis or for a charge), and offer equivalent access to the Corresponding Source in the same way through the same place at no further charge. You need not require recipients to copy the Corresponding Source along with the object code. If the place to copy the object code is a network server, the Corresponding Source may be on a different server (operated by you or a third party) that supports equivalent copying facilities, provided you maintain clear directions next to the object code saying where to find the Corresponding Source. Regardless of what server hosts the Corresponding Source, you remain obligated to ensure that it is available for as long as needed to satisfy these requirements. 100 | 101 | e) Convey the object code using peer-to-peer transmission, provided you inform other peers where the object code and Corresponding Source of the work are being offered to the general public at no charge under subsection 6d. 102 | 103 | A separable portion of the object code, whose source code is excluded from the Corresponding Source as a System Library, need not be included in conveying the object code work. 104 | 105 | A "User Product" is either (1) a "consumer product", which means any tangible personal property which is normally used for personal, family, or household purposes, or (2) anything designed or sold for incorporation into a dwelling. In determining whether a product is a consumer product, doubtful cases shall be resolved in favor of coverage. For a particular product received by a particular user, "normally used" refers to a typical or common use of that class of product, regardless of the status of the particular user or of the way in which the particular user actually uses, or expects or is expected to use, the product. A product is a consumer product regardless of whether the product has substantial commercial, industrial or non-consumer uses, unless such uses represent the only significant mode of use of the product. 106 | 107 | "Installation Information" for a User Product means any methods, procedures, authorization keys, or other information required to install and execute modified versions of a covered work in that User Product from a modified version of its Corresponding Source. The information must suffice to ensure that the continued functioning of the modified object code is in no case prevented or interfered with solely because modification has been made. 108 | 109 | If you convey an object code work under this section in, or with, or specifically for use in, a User Product, and the conveying occurs as part of a transaction in which the right of possession and use of the User Product is transferred to the recipient in perpetuity or for a fixed term (regardless of how the transaction is characterized), the Corresponding Source conveyed under this section must be accompanied by the Installation Information. But this requirement does not apply if neither you nor any third party retains the ability to install modified object code on the User Product (for example, the work has been installed in ROM). 110 | 111 | The requirement to provide Installation Information does not include a requirement to continue to provide support service, warranty, or updates for a work that has been modified or installed by the recipient, or for the User Product in which it has been modified or installed. Access to a network may be denied when the modification itself materially and adversely affects the operation of the network or violates the rules and protocols for communication across the network. 112 | 113 | Corresponding Source conveyed, and Installation Information provided, in accord with this section must be in a format that is publicly documented (and with an implementation available to the public in source code form), and must require no special password or key for unpacking, reading or copying. 114 | 115 | 7. Additional Terms. 116 | "Additional permissions" are terms that supplement the terms of this License by making exceptions from one or more of its conditions. Additional permissions that are applicable to the entire Program shall be treated as though they were included in this License, to the extent that they are valid under applicable law. If additional permissions apply only to part of the Program, that part may be used separately under those permissions, but the entire Program remains governed by this License without regard to the additional permissions. 117 | 118 | When you convey a copy of a covered work, you may at your option remove any additional permissions from that copy, or from any part of it. (Additional permissions may be written to require their own removal in certain cases when you modify the work.) You may place additional permissions on material, added by you to a covered work, for which you have or can give appropriate copyright permission. 119 | 120 | Notwithstanding any other provision of this License, for material you add to a covered work, you may (if authorized by the copyright holders of that material) supplement the terms of this License with terms: 121 | 122 | a) Disclaiming warranty or limiting liability differently from the terms of sections 15 and 16 of this License; or 123 | 124 | b) Requiring preservation of specified reasonable legal notices or author attributions in that material or in the Appropriate Legal Notices displayed by works containing it; or 125 | 126 | c) Prohibiting misrepresentation of the origin of that material, or requiring that modified versions of such material be marked in reasonable ways as different from the original version; or 127 | 128 | d) Limiting the use for publicity purposes of names of licensors or authors of the material; or 129 | 130 | e) Declining to grant rights under trademark law for use of some trade names, trademarks, or service marks; or 131 | 132 | f) Requiring indemnification of licensors and authors of that material by anyone who conveys the material (or modified versions of it) with contractual assumptions of liability to the recipient, for any liability that these contractual assumptions directly impose on those licensors and authors. 133 | 134 | All other non-permissive additional terms are considered "further restrictions" within the meaning of section 10. If the Program as you received it, or any part of it, contains a notice stating that it is governed by this License along with a term that is a further restriction, you may remove that term. If a license document contains a further restriction but permits relicensing or conveying under this License, you may add to a covered work material governed by the terms of that license document, provided that the further restriction does not survive such relicensing or conveying. 135 | 136 | If you add terms to a covered work in accord with this section, you must place, in the relevant source files, a statement of the additional terms that apply to those files, or a notice indicating where to find the applicable terms. 137 | 138 | Additional terms, permissive or non-permissive, may be stated in the form of a separately written license, or stated as exceptions; the above requirements apply either way. 139 | 140 | 8. Termination. 141 | 142 | You may not propagate or modify a covered work except as expressly provided under this License. Any attempt otherwise to propagate or modify it is void, and will automatically terminate your rights under this License (including any patent licenses granted under the third paragraph of section 11). 143 | 144 | However, if you cease all violation of this License, then your license from a particular copyright holder is reinstated (a) provisionally, unless and until the copyright holder explicitly and finally terminates your license, and (b) permanently, if the copyright holder fails to notify you of the violation by some reasonable means prior to 60 days after the cessation. 145 | 146 | Moreover, your license from a particular copyright holder is reinstated permanently if the copyright holder notifies you of the violation by some reasonable means, this is the first time you have received notice of violation of this License (for any work) from that copyright holder, and you cure the violation prior to 30 days after your receipt of the notice. 147 | 148 | Termination of your rights under this section does not terminate the licenses of parties who have received copies or rights from you under this License. If your rights have been terminated and not permanently reinstated, you do not qualify to receive new licenses for the same material under section 10. 149 | 150 | 9. Acceptance Not Required for Having Copies. 151 | 152 | You are not required to accept this License in order to receive or run a copy of the Program. Ancillary propagation of a covered work occurring solely as a consequence of using peer-to-peer transmission to receive a copy likewise does not require acceptance. However, nothing other than this License grants you permission to propagate or modify any covered work. These actions infringe copyright if you do not accept this License. Therefore, by modifying or propagating a covered work, you indicate your acceptance of this License to do so. 153 | 154 | 10. Automatic Licensing of Downstream Recipients. 155 | 156 | Each time you convey a covered work, the recipient automatically receives a license from the original licensors, to run, modify and propagate that work, subject to this License. You are not responsible for enforcing compliance by third parties with this License. 157 | 158 | An "entity transaction" is a transaction transferring control of an organization, or substantially all assets of one, or subdividing an organization, or merging organizations. If propagation of a covered work results from an entity transaction, each party to that transaction who receives a copy of the work also receives whatever licenses to the work the party's predecessor in interest had or could give under the previous paragraph, plus a right to possession of the Corresponding Source of the work from the predecessor in interest, if the predecessor has it or can get it with reasonable efforts. 159 | 160 | You may not impose any further restrictions on the exercise of the rights granted or affirmed under this License. For example, you may not impose a license fee, royalty, or other charge for exercise of rights granted under this License, and you may not initiate litigation (including a cross-claim or counterclaim in a lawsuit) alleging that any patent claim is infringed by making, using, selling, offering for sale, or importing the Program or any portion of it. 161 | 162 | 11. Patents. 163 | 164 | A "contributor" is a copyright holder who authorizes use under this License of the Program or a work on which the Program is based. The work thus licensed is called the contributor's "contributor version". 165 | 166 | A contributor's "essential patent claims" are all patent claims owned or controlled by the contributor, whether already acquired or hereafter acquired, that would be infringed by some manner, permitted by this License, of making, using, or selling its contributor version, but do not include claims that would be infringed only as a consequence of further modification of the contributor version. For purposes of this definition, "control" includes the right to grant patent sublicenses in a manner consistent with the requirements of this License. 167 | 168 | Each contributor grants you a non-exclusive, worldwide, royalty-free patent license under the contributor's essential patent claims, to make, use, sell, offer for sale, import and otherwise run, modify and propagate the contents of its contributor version. 169 | 170 | In the following three paragraphs, a "patent license" is any express agreement or commitment, however denominated, not to enforce a patent (such as an express permission to practice a patent or covenant not to sue for patent infringement). To "grant" such a patent license to a party means to make such an agreement or commitment not to enforce a patent against the party. 171 | 172 | If you convey a covered work, knowingly relying on a patent license, and the Corresponding Source of the work is not available for anyone to copy, free of charge and under the terms of this License, through a publicly available network server or other readily accessible means, then you must either (1) cause the Corresponding Source to be so available, or (2) arrange to deprive yourself of the benefit of the patent license for this particular work, or (3) arrange, in a manner consistent with the requirements of this License, to extend the patent 173 | license to downstream recipients. "Knowingly relying" means you have actual knowledge that, but for the patent license, your conveying the covered work in a country, or your recipient's use of the covered work in a country, would infringe one or more identifiable patents in that country that you have reason to believe are valid. 174 | 175 | If, pursuant to or in connection with a single transaction or arrangement, you convey, or propagate by procuring conveyance of, a covered work, and grant a patent license to some of the parties receiving the covered work authorizing them to use, propagate, modify or convey a specific copy of the covered work, then the patent license you grant is automatically extended to all recipients of the covered work and works based on it. 176 | 177 | A patent license is "discriminatory" if it does not include within the scope of its coverage, prohibits the exercise of, or is conditioned on the non-exercise of one or more of the rights that are specifically granted under this License. You may not convey a covered work if you are a party to an arrangement with a third party that is in the business of distributing software, under which you make payment to the third party based on the extent of your activity of conveying the work, and under which the third party grants, to any of the parties who would receive the covered work from you, a discriminatory patent license (a) in connection with copies of the covered work conveyed by you (or copies made from those copies), or (b) primarily for and in connection with specific products or compilations that contain the covered work, unless you entered into that arrangement, or that patent license was granted, prior to 28 March 2007. 178 | 179 | Nothing in this License shall be construed as excluding or limiting any implied license or other defenses to infringement that may otherwise be available to you under applicable patent law. 180 | 181 | 12. No Surrender of Others' Freedom. 182 | 183 | If conditions are imposed on you (whether by court order, agreement or otherwise) that contradict the conditions of this License, they do not excuse you from the conditions of this License. If you cannot convey a covered work so as to satisfy simultaneously your obligations under this License and any other pertinent obligations, then as a consequence you may 184 | not convey it at all. For example, if you agree to terms that obligate you to collect a royalty for further conveying from those to whom you convey the Program, the only way you could satisfy both those terms and this License would be to refrain entirely from conveying the Program. 185 | 186 | 13. Remote Network Interaction; Use with the GNU General Public License. 187 | 188 | Notwithstanding any other provision of this License, if you modify the Program, your modified version must prominently offer all users interacting with it remotely through a computer network (if your version supports such interaction) an opportunity to receive the Corresponding Source of your version by providing access to the Corresponding Source from a network server at no charge, through some standard or customary means of facilitating copying of software. This Corresponding Source shall include the Corresponding Source for any work covered by version 3 of the GNU General Public License that is incorporated pursuant to the following paragraph. 189 | 190 | Notwithstanding any other provision of this License, you have permission to link or combine any covered work with a work licensed under version 3 of the GNU General Public License into a single combined work, and to convey the resulting work. The terms of this License will continue to apply to the part which is the covered work, but the work with which it is combined will remain governed by version 3 of the GNU General Public License. 191 | 192 | 14. Revised Versions of this License. 193 | 194 | The Free Software Foundation may publish revised and/or new versions of the GNU Affero General Public License from time to time. Such new versions will be similar in spirit to the present version, but may differ in detail to address new problems or concerns. 195 | 196 | Each version is given a distinguishing version number. If the Program specifies that a certain numbered version of the GNU Affero General Public License "or any later version" applies to it, you have the option of following the terms and conditions either of that numbered version or of any later version published by the Free Software Foundation. If the Program does not specify a version number of the GNU Affero General Public License, you may choose any version ever published by the Free Software Foundation. 197 | 198 | If the Program specifies that a proxy can decide which future versions of the GNU Affero General Public License can be used, that proxy's public statement of acceptance of a version permanently authorizes you to choose that version for the Program. 199 | 200 | Later license versions may give you additional or different permissions. However, no additional obligations are imposed on any author or copyright holder as a result of your choosing to follow a later version. 201 | 202 | 15. Disclaimer of Warranty. 203 | 204 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 205 | 206 | 16. Limitation of Liability. 207 | 208 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. 209 | 210 | 17. Interpretation of Sections 15 and 16. 211 | 212 | If the disclaimer of warranty and limitation of liability provided above cannot be given local legal effect according to their terms, reviewing courts shall apply local law that most closely approximates an absolute waiver of all civil liability in connection with the Program, unless a warranty or assumption of liability accompanies a copy of the Program in return for a fee. 213 | 214 | END OF TERMS AND CONDITIONS 215 | 216 | How to Apply These Terms to Your New Programs 217 | 218 | If you develop a new program, and you want it to be of the greatest possible use to the public, the best way to achieve this is to make it free software which everyone can redistribute and change under these terms. 219 | 220 | To do so, attach the following notices to the program. It is safest to attach them to the start of each source file to most effectively state the exclusion of warranty; and each file should have at least the "copyright" line and a pointer to where the full notice is found. 221 | 222 | MQTT_Acker 223 | Copyright (C) 2024 remy 224 | 225 | This program is free software: you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version. 226 | 227 | This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for more details. 228 | 229 | You should have received a copy of the GNU Affero General Public License along with this program. If not, see . 230 | 231 | Also add information on how to contact you by electronic and paper mail. 232 | 233 | If your software can interact with users remotely through a computer network, you should also make sure that it provides a way for users to get its source. For example, if your program is a web application, its interface could display a "Source" link that leads users to an archive of the code. There are many ways you could offer source, and different solutions will be better for different programs; see section 13 for the specific requirements. 234 | 235 | You should also get your employer (if you work as a programmer) or school, if any, to sign a "copyright disclaimer" for the program, if necessary. For more information on this, and how to apply and follow the GNU AGPL, see . 236 | --------------------------------------------------------------------------------