├── apps2 └── .keep ├── data └── .keep ├── .gitignore ├── config ├── debug.config.php ├── smtp.config.php ├── redis.config.php ├── apps.config.php ├── previews.config.php └── autoconfig.php ├── docker-mysql-proxy ├── main.lua ├── log.lua ├── Dockerfile └── README.md ├── .travis.yml ├── docker_entrypoint.sh ├── .github ├── workflows │ ├── docker-image.yml │ └── docker-publish.yml └── dependabot.yml ├── Dockerfile ├── README.md ├── docker-compose.yml ├── nextcloud.conf └── LICENSE /apps2/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /data/.keep: -------------------------------------------------------------------------------- 1 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | *.code-workspace 2 | apps2 3 | data 4 | server 5 | -------------------------------------------------------------------------------- /config/debug.config.php: -------------------------------------------------------------------------------- 1 | 0, 4 | 'debug' => true 5 | ); 6 | -------------------------------------------------------------------------------- /docker-mysql-proxy/main.lua: -------------------------------------------------------------------------------- 1 | function read_query(packet) 2 | if string.byte(packet) == proxy.COM_QUERY then 3 | print(string.sub(packet, 2)) 4 | end 5 | end 6 | -------------------------------------------------------------------------------- /config/smtp.config.php: -------------------------------------------------------------------------------- 1 | 'smtp', 4 | 'mail_smtpauthtype' => 'PLAIN', 5 | 'mail_from_address' => 'admin', 6 | 'mail_domain' => 'yourdomain.dev', 7 | 'mail_smtphost' => 'smtp', 8 | 'mail_smtpport' => '25' 9 | ); -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | sudo: required 2 | services: 3 | - docker 4 | 5 | before_script: 6 | - docker pull skjnldsv/docker-nextcloud-dev || true 7 | 8 | script: 9 | - docker build --pull --cache-from skjnldsv/docker-nextcloud-dev --tag skjnldsv/docker-nextcloud-dev . 10 | 11 | after_script: 12 | - docker images 13 | -------------------------------------------------------------------------------- /docker_entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | # https://github.com/docker/for-linux/issues/264 3 | IP=$(ip -4 route list match 0/0 | awk '{print $3}') 4 | echo "Host ip is $IP" 5 | echo "$IP host.docker.internal" | sudo tee -a /etc/hosts 6 | 7 | cat /etc/hosts 8 | 9 | # execute default php-fpm entrypoint 10 | docker-php-entrypoint php-fpm 11 | -------------------------------------------------------------------------------- /config/redis.config.php: -------------------------------------------------------------------------------- 1 | '\OC\Memcache\Redis', 5 | 'memcache.locking' => '\OC\Memcache\Redis', 6 | 'redis' => array( 7 | 'host' => getenv('REDIS_HOST'), 8 | 'port' => getenv('REDIS_HOST_PORT') ?: 6379, 9 | ), 10 | ); 11 | } -------------------------------------------------------------------------------- /.github/workflows/docker-image.yml: -------------------------------------------------------------------------------- 1 | name: Docker Image CI 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | 11 | build: 12 | 13 | runs-on: ubuntu-latest 14 | 15 | steps: 16 | - uses: actions/checkout@v4 17 | - name: Build the Docker image 18 | run: docker build . --file Dockerfile 19 | -------------------------------------------------------------------------------- /config/apps.config.php: -------------------------------------------------------------------------------- 1 | array ( 4 | 0 => array ( 5 | "path" => OC::$SERVERROOT."/apps", 6 | "url" => "/apps", 7 | "writable" => false, 8 | ), 9 | 1 => array ( 10 | "path" => OC::$SERVERROOT."/apps2", 11 | "url" => "/apps2", 12 | "writable" => true, 13 | ), 14 | ), 15 | ); 16 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | # To get started with Dependabot version updates, you'll need to specify which 2 | # package ecosystems to update and where the package manifests are located. 3 | # Please see the documentation for all configuration options: 4 | # https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates 5 | 6 | version: 2 7 | updates: 8 | - package-ecosystem: "github-actions" 9 | directory: "/" 10 | schedule: 11 | interval: "weekly" 12 | day: "sunday" 13 | 14 | - package-ecosystem: "docker" 15 | directory: "/" 16 | schedule: 17 | interval: "weekly" 18 | day: "sunday" 19 | 20 | - package-ecosystem: "docker" 21 | directory: "/docker-mysql-proxy" 22 | schedule: 23 | interval: "weekly" 24 | day: "sunday" 25 | -------------------------------------------------------------------------------- /config/previews.config.php: -------------------------------------------------------------------------------- 1 | true, 4 | 'enabledPreviewProviders' => array( 5 | 'OC\\Preview\\AVI', 6 | 'OC\\Preview\\BMP', 7 | 'OC\\Preview\\Font', 8 | 'OC\\Preview\\GIF', 9 | 'OC\\Preview\\Illustrator', 10 | 'OC\\Preview\\Image', 11 | 'OC\\Preview\\JPEG', 12 | 'OC\\Preview\\MarkDown', 13 | 'OC\\Preview\\MKV', 14 | 'OC\\Preview\\Movie', 15 | 'OC\\Preview\\MP4', 16 | 'OC\\Preview\\MSOffice', 17 | 'OC\\Preview\\MSOffice2003', 18 | 'OC\\Preview\\MSOffice2007', 19 | 'OC\\Preview\\MSOfficeDoc', 20 | 'OC\\Preview\\OpenDocument', 21 | 'OC\\Preview\\PDF', 22 | 'OC\\Preview\\Photoshop', 23 | 'OC\\Preview\\PNG', 24 | 'OC\\Preview\\SGI', 25 | 'OC\\Preview\\SVG', 26 | 'OC\\Preview\\TGA', 27 | 'OC\\Preview\\TIFF', 28 | 'OC\\Preview\\TXT', 29 | 'OC\\Preview\\XBitmap', 30 | ), 31 | ); 32 | -------------------------------------------------------------------------------- /config/autoconfig.php: -------------------------------------------------------------------------------- 1 | 4 | 5 | ENV MYSQL_PROXY_VERSION 0.8.5 6 | ENV MYSQL_PROXY_TAR_NAME mysql-proxy-$MYSQL_PROXY_VERSION-linux-debian6.0-x86-64bit 7 | 8 | RUN apt-get update && \ 9 | DEBIAN_FRONTEND=noninteractive apt-get -y install wget && \ 10 | wget https://downloads.mysql.com/archives/get/p/21/file/$MYSQL_PROXY_TAR_NAME.tar.gz && \ 11 | tar -xzvf $MYSQL_PROXY_TAR_NAME.tar.gz && \ 12 | mv $MYSQL_PROXY_TAR_NAME /opt/mysql-proxy && \ 13 | rm $MYSQL_PROXY_TAR_NAME.tar.gz && \ 14 | DEBIAN_FRONTEND=noninteractive apt-get -y remove wget && \ 15 | apt-get clean && \ 16 | rm -rf /var/lib/apt/lists/ && \ 17 | chown -R root:root /opt/mysql-proxy && \ 18 | echo "#!/bin/bash\n\ 19 | \n\ 20 | exec /opt/mysql-proxy/bin/mysql-proxy \\\\\n\ 21 | --keepalive \\\\\n\ 22 | --log-level=debug \\\\\n\ 23 | --plugins=proxy \\\\\n\ 24 | --proxy-address=\${PROXY_DB_HOST}:\${PROXY_DB_PORT} \\\\\n\ 25 | --proxy-backend-addresses=\${REMOTE_DB_HOST}:\${REMOTE_DB_PORT} \\\\\n\ 26 | --proxy-lua-script=\${LUA_SCRIPT}\n\ 27 | " >> /usr/local/bin//entrypoint.sh && \ 28 | chmod u+x /usr/local/bin/entrypoint.sh && \ 29 | ln -s /usr/local/bin/docker-entrypoint.sh /entrypoint.sh # shortcut 30 | EXPOSE 4040 4041 31 | 32 | ENTRYPOINT [ "entrypoint.sh" ] 33 | 34 | 35 | # For another derived image: 36 | 37 | # --help-all 38 | # --proxy-backend-addresses=mysql:3306 39 | # --proxy-skip-profiling 40 | # --proxy-backend-addresses=host:port 41 | # --proxy-read-only-backend-addresses=host:port 42 | # --keepalive 43 | # --admin-username=User 44 | # --admin-password=Password 45 | # --log-level=crititcal 46 | # The log level to use when outputting error messages. 47 | # Messages with that level (or lower) are output. 48 | # For example, message level also outputs message with info, warning, and error levels. 49 | -------------------------------------------------------------------------------- /Dockerfile: -------------------------------------------------------------------------------- 1 | FROM php:8.4-fpm 2 | 3 | # entrypoint.sh and cron.sh dependencies 4 | RUN set -ex; \ 5 | \ 6 | apt-get update; \ 7 | apt-get install -y --no-install-recommends \ 8 | iproute2 \ 9 | sudo \ 10 | rsync \ 11 | bzip2 \ 12 | busybox-static \ 13 | curl \ 14 | smbclient \ 15 | ; \ 16 | rm -rf /var/lib/apt/lists/*; \ 17 | \ 18 | mkdir -p /var/spool/cron/crontabs; \ 19 | echo '*/15 * * * * php -f /var/www/html/cron.php' > /var/spool/cron/crontabs/www-data 20 | 21 | # Install phpunit 7 22 | RUN curl -L https://phar.phpunit.de/phpunit-8.phar > /usr/local/bin/phpunit \ 23 | && chmod +x /usr/local/bin/phpunit 24 | 25 | # install the PHP extensions we need 26 | # see https://docs.nextcloud.com/server/12/admin_manual/installation/source_installation.html 27 | RUN curl -sSLf \ 28 | -o /usr/local/bin/install-php-extensions \ 29 | https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions && \ 30 | chmod +x /usr/local/bin/install-php-extensions 31 | 32 | RUN install-php-extensions \ 33 | apcu \ 34 | exif \ 35 | gd \ 36 | imagick \ 37 | intl \ 38 | ldap \ 39 | memcached \ 40 | pcntl \ 41 | pdo_mysql \ 42 | pdo_pgsql \ 43 | redis \ 44 | smbclient \ 45 | xdebug \ 46 | zip 47 | 48 | # samba 49 | RUN { \ 50 | echo '[global]'; \ 51 | echo 'client min protocol = SMB2'; \ 52 | echo 'client max protocol = SMB3'; \ 53 | echo 'hide dot files = no'; \ 54 | } > /etc/samba/smb.conf 55 | 56 | # npm 57 | RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.34.0/install.sh | bash \ 58 | && export NVM_DIR="/root/.nvm" \ 59 | && . "$NVM_DIR/nvm.sh" \ 60 | && nvm install --lts 61 | 62 | # set recommended PHP.ini settings 63 | # see https://docs.nextcloud.com/server/12/admin_manual/configuration_server/server_tuning.html 64 | RUN echo 'memory_limit=512M' > /usr/local/etc/php/conf.d/memory-limit.ini; \ 65 | \ 66 | mkdir /var/www/data; \ 67 | chown -R www-data:root /var/www; \ 68 | chmod -R g=u /var/www 69 | 70 | # Add a "docker" user 71 | RUN useradd docker --shell /bin/bash --create-home \ 72 | && usermod --append --groups sudo docker \ 73 | && echo 'ALL ALL = (ALL) NOPASSWD: ALL' >> /etc/sudoers \ 74 | && echo 'docker:secret' | chpasswd 75 | 76 | # Cleanup 77 | RUN apt-get clean && apt-get --yes --quiet autoremove --purge \ 78 | && rm -Rf /tmp/* 79 | 80 | ADD docker_entrypoint.sh /usr/local/bin/docker_entrypoint.sh 81 | RUN chmod a+x /usr/local/bin/docker_entrypoint.sh 82 | 83 | USER docker 84 | 85 | VOLUME /var/www/nextcloud 86 | WORKDIR /var/www/nextcloud 87 | 88 | ENTRYPOINT ["/usr/local/bin/docker_entrypoint.sh"] 89 | -------------------------------------------------------------------------------- /.github/workflows/docker-publish.yml: -------------------------------------------------------------------------------- 1 | name: Docker 2 | 3 | # This workflow uses actions that are not certified by GitHub. 4 | # They are provided by a third-party and are governed by 5 | # separate terms of service, privacy policy, and support 6 | # documentation. 7 | 8 | on: 9 | schedule: 10 | - cron: '30 23 * * *' 11 | push: 12 | branches: [ "master" ] 13 | # Publish semver tags as releases. 14 | tags: [ 'v*.*.*' ] 15 | pull_request: 16 | branches: [ "master" ] 17 | 18 | env: 19 | # Use docker.io for Docker Hub if empty 20 | REGISTRY: ghcr.io 21 | # github.repository as / 22 | IMAGE_NAME: ${{ github.repository }} 23 | 24 | 25 | jobs: 26 | build: 27 | 28 | runs-on: ubuntu-latest 29 | permissions: 30 | contents: read 31 | packages: write 32 | # This is used to complete the identity challenge 33 | # with sigstore/fulcio when running outside of PRs. 34 | id-token: write 35 | 36 | steps: 37 | - name: Checkout repository 38 | uses: actions/checkout@v4 39 | 40 | # Install the cosign tool except on PR 41 | # https://github.com/sigstore/cosign-installer 42 | - name: Install cosign 43 | if: github.event_name != 'pull_request' 44 | uses: sigstore/cosign-installer@4959ce089c160fddf62f7b42464195ba1a56d382 #v3.6.0 45 | with: 46 | cosign-release: 'v2.1.1' 47 | 48 | # Set up BuildKit Docker container builder to be able to build 49 | # multi-platform images and export cache 50 | # https://github.com/docker/setup-buildx-action 51 | - name: Set up Docker Buildx 52 | uses: docker/setup-buildx-action@988b5a0280414f521da01fcc63a27aeeb4b104db # v3.6.1 53 | 54 | # Login against a Docker registry except on PR 55 | # https://github.com/docker/login-action 56 | - name: Log into registry ${{ env.REGISTRY }} 57 | if: github.event_name != 'pull_request' 58 | uses: docker/login-action@9780b0c442fbb1117ed29e0efdff1e18412f7567 # v3.3.0 59 | with: 60 | registry: ${{ env.REGISTRY }} 61 | username: ${{ github.actor }} 62 | password: ${{ secrets.GITHUB_TOKEN }} 63 | 64 | # Extract metadata (tags, labels) for Docker 65 | # https://github.com/docker/metadata-action 66 | - name: Extract Docker metadata 67 | id: meta 68 | uses: docker/metadata-action@8e5442c4ef9f78752691e2d8f8d19755c6f78e81 # v5.5.1 69 | with: 70 | images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }} 71 | 72 | # Build and push Docker image with Buildx (don't push on PR) 73 | # https://github.com/docker/build-push-action 74 | - name: Build and push Docker image 75 | id: build-and-push 76 | uses: docker/build-push-action@5cd11c3a4ced054e52742c5fd54dca954e0edd85 # v6.7.0 77 | with: 78 | context: . 79 | push: ${{ github.event_name != 'pull_request' }} 80 | tags: ${{ steps.meta.outputs.tags }},skjnldsv/docker-nextcloud-dev:latest 81 | labels: ${{ steps.meta.outputs.labels }} 82 | cache-from: type=gha 83 | cache-to: type=gha,mode=max 84 | -------------------------------------------------------------------------------- /docker-mysql-proxy/README.md: -------------------------------------------------------------------------------- 1 | # mysql-proxy 2 | 3 | # Usage with docker-compose 4 | 5 | without 6 | ``` 7 | version: '2' 8 | 9 | services: 10 | db: 11 | image: mysql:8.0.0 12 | restart: always 13 | ports: 14 | - "3307:3306" #for external connection 15 | volumes: 16 | - ../mysql-data/db:/var/lib/mysql #mysql-data 17 | environment: 18 | MYSQL_ROOT_PASSWORD: password 19 | MYSQL_DATABASE: dbuser 20 | MYSQL_USER: dbuser 21 | MYSQL_PASSWORD: password 22 | ``` 23 | 24 | within 25 | ``` 26 | version: '2' 27 | 28 | services: 29 | mysql: 30 | image: mysql:8.0.0 31 | restart: always 32 | expose: 33 | - "3306" #for service mysql-proxy 34 | ports: 35 | - "3307:3306" #for external connection 36 | volumes: 37 | - ../mysql-data/db:/var/lib/mysql #mysql-data 38 | environment: 39 | MYSQL_ROOT_PASSWORD: password 40 | MYSQL_DATABASE: dbuser 41 | MYSQL_USER: dbuser 42 | MYSQL_PASSWORD: password 43 | db: 44 | image: bscheshir/mysqlproxy:0.8.5 45 | expose: 46 | - "3306" #for service php 47 | ports: 48 | - "3308:3306" #for external connection 49 | restart: always 50 | volumes: 51 | - ../mysql-proxy-conf:/opt/mysql-proxy/conf 52 | environment: 53 | PROXY_DB_PORT: 3306 54 | REMOTE_DB_HOST: mysql 55 | REMOTE_DB_PORT: 3306 56 | LUA_SCRIPT: "/opt/mysql-proxy/conf/main.lua" 57 | depends_on: 58 | - mysql 59 | ``` 60 | 61 | # Query to stdout 62 | For `docker-compose up` without `-d` (`../mysql-proxy/main.lua`) 63 | ``` 64 | function read_query(packet) 65 | if string.byte(packet) == proxy.COM_QUERY then 66 | print(string.sub(packet, 2)) 67 | end 68 | end 69 | ``` 70 | 71 | # Query logging for mysql-proxy 72 | 73 | ``` 74 | ... 75 | volumes: 76 | - ../mysql-proxy-conf:/opt/mysql-proxy/conf 77 | - ../mysql-proxy-logs:/opt/mysql-proxy/logs 78 | environment: 79 | PROXY_DB_PORT: 3306 80 | REMOTE_DB_HOST: mysql 81 | REMOTE_DB_PORT: 3306 82 | LUA_SCRIPT: "/opt/mysql-proxy/conf/log.lua" 83 | LOG_FILE: "/opt/mysql-proxy/logs/mysql.log" 84 | ... 85 | ``` 86 | 87 | `/mysql-proxy-conf/log.lua` https://gist.github.com/simonw/1039751 88 | ``` 89 | local log_file = os.getenv("LOG_FILE") 90 | 91 | local fh = io.open(log_file, "a+") 92 | 93 | function read_query( packet ) 94 | if string.byte(packet) == proxy.COM_QUERY then 95 | local query = string.sub(packet, 2) 96 | fh:write( string.format("%s %6d -- %s \n", 97 | os.date('%Y-%m-%d %H:%M:%S'), 98 | proxy.connection.server["thread_id"], 99 | query)) 100 | fh:flush() 101 | end 102 | end 103 | ``` 104 | # thanks 105 | 106 | https://hub.docker.com/r/zwxajh/mysql-proxy 107 | https://hub.docker.com/r/gediminaspuksmys/mysqlproxy/ 108 | 109 | # logrotate 110 | The image can be expand with `logrotate` 111 | Config file `/etc/logrotate.d/mysql-proxy` (approximate) 112 | 113 | ``` 114 | /opt/mysql-proxy/mysql.log { 115 | weekly 116 | missingok 117 | rotate 35600 118 | compress 119 | delaycompress 120 | notifempty 121 | create 666 root root 122 | postrotate 123 | /etc/init.d/mysql-proxy reload > /dev/null 124 | endscript 125 | } 126 | ``` 127 | 128 | # troubleshooting 129 | If you can't create the chain `mysql` -> `mysql-proxy` -> `external client liten 0.0.0.0:3308` 130 | check extends ports on the `mysql` service and/or add `expose` directly 131 | ``` 132 | expose: 133 | - "3306" #for service mysql-proxy 134 | ``` 135 | 136 | > note: Log send to file with delay (buffering mechanism). You can restart the container for get the log immediately. -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | [![Docker Automated build](https://img.shields.io/docker/automated/skjnldsv/nextcloud-dev.svg?style=flat-square)](https://hub.docker.com/r/skjnldsv/nextcloud-dev/) [![Docker Pulls](https://img.shields.io/docker/pulls/skjnldsv/nextcloud-dev.svg?style=flat-square)](https://hub.docker.com/r/skjnldsv/nextcloud-dev/) 2 | 3 | 4 | ## This is a nextcloud development environment stack for docker🚀 5 | 6 | This is a php docker designed to be used with the compose file present in this repository. 7 | This is not designed to be a quick dev setup on the fly, but rather a semi-permanent setup. 💻 8 | Built-in: phpunit, ldap, gd, imagick, APCu, redis, memcached... 9 | 10 | We basically use the same nginx config than the documentation: https://docs.nextcloud.com/server/stable/admin_manual/installation/nginx.html 11 | Only the php-handler server is changed to the php container 12 | 13 | ## How-to 🤔 14 | 15 | 1. Download this repository and rename it the way you want 16 | 2. Into the docker folder, clone [nextcloud server](https://github.com/nextcloud/server) 17 | ```sh 18 | git clone git@github.com:nextcloud/server.git 19 | ``` 20 | 3. Into the `server` folder, update the 3rdparty submodule: `git submodule update --init` 21 | ```sh 22 | cd server 23 | git submodule update --init 24 | cd .. 25 | ``` 26 | 4. Execute the stack: `docker-compose up -d` 27 | 5. Access the nextcloud through https://localhost 28 | 6. Go to the setup of your nextcloud, enter your desired username and your password 29 | 7. Enjoy contributing! 🥂 🎉 30 | 31 | ## Using https 🔐 32 | 1. We now generate self signed certificates on start. 33 | 2. Before starting it, you can edit the domain in the `docker-compose.yml` file, check for the omgwtfssl service. 34 | 3. Currently the config is made to redirect all http traffic to https. 35 | 4. You will see an error at first because the ssl certificates are not approved by a trust entity, this is all safe, you just generated them. Approve them manually on your browser and start using your dev stack :wink: 36 | 37 | ## Retrieve a container's IP 🌐 38 | ```sh 39 | $ docker-compose exec web hostname -i 40 | 172.20.0.3 41 | ``` 42 | 43 | ## Install apps 👾 44 | - If you want to install apps, you can directly go into your apps management 45 | - **but** if you want to work on apps development, just clone their git repository into the apps2 folder (on the root, not on the server folder) 46 | 47 | ## Change the database config 🙌 48 | We use mariadb by default. If you don't want it, you can: 49 | 1. Remove the db **and** phpmyadmin (if present) service form the compose file 50 | 2. Remove the `MYSQL` environment params of the php service in the compose file 51 | 3. Go to the setup of your nextcloud and choose the desired database 52 | 53 | ## OCC commands ⌨ 54 | You can run any occ command with docker (example: upgrade) 55 | ```sh 56 | $ docker-compose exec --user=docker php php occ upgrade 57 | ``` 58 | 59 | ## Phpunit ⛑ 60 | You can run the test you want with phpunit bootstrap 61 | ```sh 62 | $ docker-compose exec --user=docker php phpunit --bootstrap tests/bootstrap.php tests/Core/Controller/ClientFlowLoginControllerTest.php 63 | ``` 64 | Or the full suite: 65 | ```sh 66 | $ docker-compose exec php phpunit --configuration tests/phpunit-autotest.xml 67 | ``` 68 | ## Access and manage the database 🗃 69 | If you used the default setup with mariadb, you can enable phpmyadmin directly. 70 | 1. Uncomment the phpmyadmin service in your `docker-compose` file 71 | 2. Run the service: `docker-compose start phpmyadmin` 72 | 3. Retrieve phpmyadmin's IP: `docker-compose exec phpmyadmin hostname -i` (example: 172.20.0.4) 73 | 4. Open your browser and access the ip directly (e.g. http://172.20.0.4/) 74 | 5. Use your database root user (default user `root`, pass: `rootpassword`) 75 | The database default name is nextcloud 76 | 77 | ## Quick smtp 78 | Want a quick smtp server to test emails on nextcloud ? 79 | 1. On your compose file, uncomment the smtp service and the smtp volume binding on the php service. 80 | 2. Edit your `smtp.config.php` file and change the domain by your domain 81 | (make sure you've set your email in your nextcloud user account) 82 | 3. Go on the nextcloud smtp settings and click the `Send test email` button! 83 | 4. You've got mail! 📫 84 | 85 | ## Troubleshooting 86 | - *The files of the app (viewer) were not replaced correctly.* Solution: execute `git clone https://github.com/nextcloud/viewer.git` in the apps2 directory 87 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | version: '2' 2 | 3 | volumes: 4 | mariadb: 5 | web-certs: 6 | 7 | networks: 8 | nextcloud: 9 | 10 | services: 11 | mysql: 12 | image: mariadb 13 | restart: always 14 | # https://docs.nextcloud.com/server/stable/admin_manual/configuration_database/mysql_4byte_support.html 15 | command: --character-set-server=utf8mb4 --collation-server=utf8mb4_general_ci --innodb-large-prefix --innodb-file-per-table --innodb-file-format=barracuda --skip-innodb-read-only-compressed 16 | volumes: 17 | - mariadb:/var/lib/mysql 18 | environment: 19 | - MYSQL_ROOT_PASSWORD=rootpassword 20 | - MYSQL_PASSWORD=password 21 | - MYSQL_DATABASE=nextcloud 22 | - MYSQL_USER=nextcloud 23 | networks: 24 | - nextcloud 25 | 26 | # DB proxy: watch docker logs to see all sql queries 27 | # `docker-compose logs -f db` 28 | db: 29 | build: ./docker-mysql-proxy 30 | restart: always 31 | volumes: 32 | - ./docker-mysql-proxy/log.lua:/opt/mysql-proxy/conf/log.lua:ro 33 | - ./docker-mysql-proxy/main.lua:/opt/mysql-proxy/conf/main.lua:ro 34 | environment: 35 | PROXY_DB_PORT: 3306 36 | REMOTE_DB_HOST: mysql 37 | REMOTE_DB_PORT: 3306 38 | LUA_SCRIPT: "/opt/mysql-proxy/conf/main.lua" 39 | LOG_FILE: "/tmp/mysql.log" 40 | depends_on: 41 | - mysql 42 | networks: 43 | - nextcloud 44 | 45 | php: 46 | image: skjnldsv/nextcloud-dev 47 | volumes: 48 | - ./server:/var/www/nextcloud 49 | - ./data:/var/www/nextcloud/data 50 | - ./apps2:/var/www/nextcloud/apps2 51 | # COMMENT IF YOU WANT FULL CONTROL ON THE NEXTCLOUD INITIAL SETUP 52 | - ./config/autoconfig.php:/var/www/nextcloud/config/autoconfig.php:ro 53 | - ./config/debug.config.php:/var/www/nextcloud/config/debug.config.php:ro 54 | # COMMENT TO DISABLE REDIS 55 | - ./config/redis.config.php:/var/www/nextcloud/config/redis.config.php:ro 56 | # UNCOMMENT TO ENABLE SMTP 57 | # - ./config/smtp.config.php:/var/www/nextcloud/config/smtp.config.php:ro 58 | - ./config/apps.config.php:/var/www/nextcloud/config/apps.config.php:ro 59 | restart: always 60 | environment: 61 | # use mysql instead of db if you disabled the db proxy 62 | - MYSQL_HOST=db 63 | - MYSQL_PASSWORD=password 64 | - MYSQL_DATABASE=nextcloud 65 | - MYSQL_USER=nextcloud 66 | # comment if redis is disabled 67 | - REDIS_HOST=redis 68 | - PHP_IDE_CONFIG='serverName=cli' 69 | - NEXTCLOUD_DATA_DIR=/var/www/nextcloud/data 70 | # UNCOMMENT TO ENABLE XDEBUG 71 | # host.docker.internal is initiated on the container on each start 72 | # and bound to the host ip 73 | - XDEBUG_CONFIG=remote_host=host.docker.internal remote_autostart=On remote_enable=On idekey=XDEBUG remote_log=/tmp/xdebug.log remote_port=9999 74 | - PHP_XDEBUG_ENABLED=1 75 | - PHP_XDEBUG_IDE_KEY=XDEBUG 76 | depends_on: 77 | # use mysql instead of db if you disabled the db proxy 78 | - db 79 | # comment if redis is disabled 80 | - redis 81 | networks: 82 | - nextcloud 83 | 84 | web: 85 | image: nginx 86 | ports: 87 | - 443:443 88 | - 80:80 89 | volumes: 90 | - ./server:/var/www/nextcloud 91 | - ./apps2:/var/www/nextcloud/apps2 92 | - ./nextcloud.conf:/etc/nginx/conf.d/default.conf:ro 93 | - web-certs:/etc/nginx/certs:ro 94 | restart: always 95 | networks: 96 | - nextcloud 97 | depends_on: 98 | - php 99 | 100 | omgwtfssl: 101 | image: paulczar/omgwtfssl 102 | volumes: 103 | - web-certs:/certs 104 | environment: 105 | # CHANGE IT TO YOU DOMAIN NAME 106 | - SSL_SUBJECT=dev.domain.com 107 | networks: 108 | - nextcloud 109 | 110 | # UNCOMMENT TO ENABLE PHPMYADMIN 111 | # phpmyadmin: 112 | # image: phpmyadmin/phpmyadmin:latest 113 | # environment: 114 | # - MYSQL_ROOT_PASSWORD=rootpassword 115 | # - MYSQL_PASSWORD=password 116 | # - MYSQL_DATABASE=nextcloud 117 | # - MYSQL_USER=nextcloud 118 | # # use mysql instead of db if you disabled the db proxy 119 | # - PMA_HOST=db 120 | # restart: always 121 | # networks: 122 | # - nextcloud 123 | # depends_on: 124 | # # use mysql instead of db if you disabled the db proxy 125 | # - db 126 | 127 | # UNCOMMENT TO ENABLE SMTP 128 | # smtp: 129 | # image: namshi/smtp 130 | # restart: always 131 | # networks: 132 | # - nextcloud 133 | 134 | # COMMENT TO DISABLE REDIS 135 | redis: 136 | image: redis:latest 137 | restart: always 138 | networks: 139 | - nextcloud 140 | -------------------------------------------------------------------------------- /nextcloud.conf: -------------------------------------------------------------------------------- 1 | upstream php-handler { 2 | server php:9000; 3 | #server unix:/var/run/php/php7.4-fpm.sock; 4 | } 5 | 6 | # Set the `immutable` cache control options only for assets with a cache busting `v` argument 7 | map $arg_v $asset_immutable { 8 | "" ""; 9 | default "immutable"; 10 | } 11 | 12 | 13 | server { 14 | listen 80; 15 | listen [::]:80; 16 | 17 | # Prevent nginx HTTP Server Detection 18 | server_tokens off; 19 | 20 | # Enforce HTTPS 21 | return 301 https://$server_name$request_uri; 22 | } 23 | 24 | server { 25 | listen 443 ssl http2; 26 | listen [::]:443 ssl http2; 27 | 28 | # Path to the root of your installation 29 | root /var/www/nextcloud; 30 | 31 | # Use Mozilla's guidelines for SSL/TLS settings 32 | # https://mozilla.github.io/server-side-tls/ssl-config-generator/ 33 | # NOTE: some settings below might be redundant 34 | ssl_certificate /etc/nginx/certs/cert.pem; 35 | ssl_certificate_key /etc/nginx/certs/key.pem; 36 | 37 | # Prevent nginx HTTP Server Detection 38 | server_tokens off; 39 | 40 | # HSTS settings 41 | # WARNING: Only add the preload option once you read about 42 | # the consequences in https://hstspreload.org/. This option 43 | # will add the domain to a hardcoded list that is shipped 44 | # in all major browsers and getting removed from this list 45 | # could take several months. 46 | #add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload" always; 47 | 48 | # set max upload size and increase upload timeout: 49 | client_max_body_size 512M; 50 | client_body_timeout 300s; 51 | fastcgi_buffers 64 4K; 52 | 53 | # Enable gzip but do not remove ETag headers 54 | gzip on; 55 | gzip_vary on; 56 | gzip_comp_level 4; 57 | gzip_min_length 256; 58 | gzip_proxied expired no-cache no-store private no_last_modified no_etag auth; 59 | gzip_types application/atom+xml text/javascript application/javascript application/json application/ld+json application/manifest+json application/rss+xml application/vnd.geo+json application/vnd.ms-fontobject application/wasm application/x-font-ttf application/x-web-app-manifest+json application/xhtml+xml application/xml font/opentype image/bmp image/svg+xml image/x-icon text/cache-manifest text/css text/plain text/vcard text/vnd.rim.location.xloc text/vtt text/x-component text/x-cross-domain-policy; 60 | 61 | # Pagespeed is not supported by Nextcloud, so if your server is built 62 | # with the `ngx_pagespeed` module, uncomment this line to disable it. 63 | #pagespeed off; 64 | 65 | # The settings allows you to optimize the HTTP2 bandwitdth. 66 | # See https://blog.cloudflare.com/delivering-http-2-upload-speed-improvements/ 67 | # for tunning hints 68 | client_body_buffer_size 512k; 69 | 70 | # HTTP response headers borrowed from Nextcloud `.htaccess` 71 | add_header Referrer-Policy "no-referrer" always; 72 | add_header X-Content-Type-Options "nosniff" always; 73 | add_header X-Download-Options "noopen" always; 74 | add_header X-Frame-Options "SAMEORIGIN" always; 75 | add_header X-Permitted-Cross-Domain-Policies "none" always; 76 | add_header X-Robots-Tag "noindex, nofollow" always; 77 | add_header X-XSS-Protection "1; mode=block" always; 78 | 79 | # Remove X-Powered-By, which is an information leak 80 | fastcgi_hide_header X-Powered-By; 81 | 82 | # Add .mjs as a file extension for javascript 83 | # Either include it in the default mime.types list 84 | # or include you can include that list explicitly and add the file extension 85 | # only for Nextcloud like below: 86 | include mime.types; 87 | types { 88 | text/javascript js mjs; 89 | } 90 | 91 | # Specify how to handle directories -- specifying `/index.php$request_uri` 92 | # here as the fallback means that Nginx always exhibits the desired behaviour 93 | # when a client requests a path that corresponds to a directory that exists 94 | # on the server. In particular, if that directory contains an index.php file, 95 | # that file is correctly served; if it doesn't, then the request is passed to 96 | # the front-end controller. This consistent behaviour means that we don't need 97 | # to specify custom rules for certain paths (e.g. images and other assets, 98 | # `/updater`, `/ocm-provider`, `/ocs-provider`), and thus 99 | # `try_files $uri $uri/ /index.php$request_uri` 100 | # always provides the desired behaviour. 101 | index index.php index.html /index.php$request_uri; 102 | 103 | # Rule borrowed from `.htaccess` to handle Microsoft DAV clients 104 | location = / { 105 | if ( $http_user_agent ~ ^DavClnt ) { 106 | return 302 /remote.php/webdav/$is_args$args; 107 | } 108 | } 109 | 110 | location = /robots.txt { 111 | allow all; 112 | log_not_found off; 113 | access_log off; 114 | } 115 | 116 | # Make a regex exception for `/.well-known` so that clients can still 117 | # access it despite the existence of the regex rule 118 | # `location ~ /(\.|autotest|...)` which would otherwise handle requests 119 | # for `/.well-known`. 120 | location ^~ /.well-known { 121 | # The rules in this block are an adaptation of the rules 122 | # in `.htaccess` that concern `/.well-known`. 123 | 124 | location = /.well-known/carddav { return 301 /remote.php/dav/; } 125 | location = /.well-known/caldav { return 301 /remote.php/dav/; } 126 | 127 | location /.well-known/acme-challenge { try_files $uri $uri/ =404; } 128 | location /.well-known/pki-validation { try_files $uri $uri/ =404; } 129 | 130 | # Let Nextcloud's API for `/.well-known` URIs handle all other 131 | # requests by passing them to the front-end controller. 132 | return 301 /index.php$request_uri; 133 | } 134 | 135 | # Rules borrowed from `.htaccess` to hide certain paths from clients 136 | location ~ ^/(?:build|tests|config|lib|3rdparty|templates|data)(?:$|/) { return 404; } 137 | location ~ ^/(?:\.|autotest|occ|issue|indie|db_|console) { return 404; } 138 | 139 | # Ensure this block, which passes PHP files to the PHP process, is above the blocks 140 | # which handle static assets (as seen below). If this block is not declared first, 141 | # then Nginx will encounter an infinite rewriting loop when it prepends `/index.php` 142 | # to the URI, resulting in a HTTP 500 error response. 143 | location ~ \.php(?:$|/) { 144 | # Required for legacy support 145 | rewrite ^/(?!index|remote|public|cron|core\/ajax\/update|status|ocs\/v[12]|updater\/.+|oc[ms]-provider\/.+|.+\/richdocumentscode\/proxy) /index.php$request_uri; 146 | 147 | fastcgi_split_path_info ^(.+?\.php)(/.*)$; 148 | set $path_info $fastcgi_path_info; 149 | 150 | try_files $fastcgi_script_name =404; 151 | 152 | include fastcgi_params; 153 | fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 154 | fastcgi_param PATH_INFO $path_info; 155 | fastcgi_param HTTPS on; 156 | 157 | fastcgi_param modHeadersAvailable true; # Avoid sending the security headers twice 158 | fastcgi_param front_controller_active true; # Enable pretty urls 159 | fastcgi_pass php-handler; 160 | 161 | fastcgi_intercept_errors on; 162 | fastcgi_request_buffering off; 163 | 164 | fastcgi_max_temp_file_size 0; 165 | } 166 | 167 | # Serve static files 168 | location ~ \.(?:css|js|mjs|svg|gif|png|jpg|ico|wasm|tflite|map)$ { 169 | try_files $uri /index.php$request_uri; 170 | add_header Cache-Control "public, max-age=15778463, $asset_immutable"; 171 | access_log off; # Optional: Don't log access to assets 172 | 173 | location ~ \.wasm$ { 174 | default_type application/wasm; 175 | } 176 | } 177 | 178 | location ~ \.woff2?$ { 179 | try_files $uri /index.php$request_uri; 180 | expires 7d; # Cache-Control policy borrowed from `.htaccess` 181 | access_log off; # Optional: Don't log access to assets 182 | } 183 | 184 | # Rule borrowed from `.htaccess` 185 | location /remote { 186 | return 301 /remote.php$request_uri; 187 | } 188 | 189 | location / { 190 | try_files $uri $uri/ /index.php$request_uri; 191 | } 192 | } 193 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | GNU AFFERO GENERAL PUBLIC LICENSE 2 | Version 3, 19 November 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | 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 11 | software and other kinds of works, specifically designed to ensure 12 | cooperation with the community in the case of network server software. 13 | 14 | The licenses for most software and other practical works are designed 15 | to take away your freedom to share and change the works. By contrast, 16 | our General Public Licenses are intended to guarantee your freedom to 17 | share and change all versions of a program--to make sure it remains free 18 | software for all its users. 19 | 20 | When we speak of free software, we are referring to freedom, not 21 | price. Our General Public Licenses are designed to make sure that you 22 | have the freedom to distribute copies of free software (and charge for 23 | them if you wish), that you receive source code or can get it if you 24 | want it, that you can change the software or use pieces of it in new 25 | free programs, and that you know you can do these things. 26 | 27 | Developers that use our General Public Licenses protect your rights 28 | with two steps: (1) assert copyright on the software, and (2) offer 29 | you this License which gives you legal permission to copy, distribute 30 | and/or modify the software. 31 | 32 | A secondary benefit of defending all users' freedom is that 33 | improvements made in alternate versions of the program, if they 34 | receive widespread use, become available for other developers to 35 | incorporate. Many developers of free software are heartened and 36 | encouraged by the resulting cooperation. However, in the case of 37 | software used on network servers, this result may fail to come about. 38 | The GNU General Public License permits making a modified version and 39 | letting the public access it on a server without ever releasing its 40 | source code to the public. 41 | 42 | The GNU Affero General Public License is designed specifically to 43 | ensure that, in such cases, the modified source code becomes available 44 | to the community. It requires the operator of a network server to 45 | provide the source code of the modified version running there to the 46 | users of that server. Therefore, public use of a modified version, on 47 | a publicly accessible server, gives the public access to the source 48 | code of the modified version. 49 | 50 | An older license, called the Affero General Public License and 51 | published by Affero, was designed to accomplish similar goals. This is 52 | a different license, not a version of the Affero GPL, but Affero has 53 | released a new version of the Affero GPL which permits relicensing under 54 | this license. 55 | 56 | The precise terms and conditions for copying, distribution and 57 | modification follow. 58 | 59 | TERMS AND CONDITIONS 60 | 61 | 0. Definitions. 62 | 63 | "This License" refers to version 3 of the GNU Affero General Public License. 64 | 65 | "Copyright" also means copyright-like laws that apply to other kinds of 66 | works, such as semiconductor masks. 67 | 68 | "The Program" refers to any copyrightable work licensed under this 69 | License. Each licensee is addressed as "you". "Licensees" and 70 | "recipients" may be individuals or organizations. 71 | 72 | To "modify" a work means to copy from or adapt all or part of the work 73 | in a fashion requiring copyright permission, other than the making of an 74 | exact copy. The resulting work is called a "modified version" of the 75 | earlier work or a work "based on" the earlier work. 76 | 77 | A "covered work" means either the unmodified Program or a work based 78 | on the Program. 79 | 80 | To "propagate" a work means to do anything with it that, without 81 | permission, would make you directly or secondarily liable for 82 | infringement under applicable copyright law, except executing it on a 83 | computer or modifying a private copy. Propagation includes copying, 84 | distribution (with or without modification), making available to the 85 | public, and in some countries other activities as well. 86 | 87 | To "convey" a work means any kind of propagation that enables other 88 | parties to make or receive copies. Mere interaction with a user through 89 | a computer network, with no transfer of a copy, is not conveying. 90 | 91 | An interactive user interface displays "Appropriate Legal Notices" 92 | to the extent that it includes a convenient and prominently visible 93 | feature that (1) displays an appropriate copyright notice, and (2) 94 | tells the user that there is no warranty for the work (except to the 95 | extent that warranties are provided), that licensees may convey the 96 | work under this License, and how to view a copy of this License. If 97 | the interface presents a list of user commands or options, such as a 98 | menu, a prominent item in the list meets this criterion. 99 | 100 | 1. Source Code. 101 | 102 | The "source code" for a work means the preferred form of the work 103 | for making modifications to it. "Object code" means any non-source 104 | form of a work. 105 | 106 | A "Standard Interface" means an interface that either is an official 107 | standard defined by a recognized standards body, or, in the case of 108 | interfaces specified for a particular programming language, one that 109 | is widely used among developers working in that language. 110 | 111 | The "System Libraries" of an executable work include anything, other 112 | than the work as a whole, that (a) is included in the normal form of 113 | packaging a Major Component, but which is not part of that Major 114 | Component, and (b) serves only to enable use of the work with that 115 | Major Component, or to implement a Standard Interface for which an 116 | implementation is available to the public in source code form. A 117 | "Major Component", in this context, means a major essential component 118 | (kernel, window system, and so on) of the specific operating system 119 | (if any) on which the executable work runs, or a compiler used to 120 | produce the work, or an object code interpreter used to run it. 121 | 122 | The "Corresponding Source" for a work in object code form means all 123 | the source code needed to generate, install, and (for an executable 124 | work) run the object code and to modify the work, including scripts to 125 | control those activities. However, it does not include the work's 126 | System Libraries, or general-purpose tools or generally available free 127 | programs which are used unmodified in performing those activities but 128 | which are not part of the work. For example, Corresponding Source 129 | includes interface definition files associated with source files for 130 | the work, and the source code for shared libraries and dynamically 131 | linked subprograms that the work is specifically designed to require, 132 | such as by intimate data communication or control flow between those 133 | subprograms and other parts of the work. 134 | 135 | The Corresponding Source need not include anything that users 136 | can regenerate automatically from other parts of the Corresponding 137 | Source. 138 | 139 | The Corresponding Source for a work in source code form is that 140 | same work. 141 | 142 | 2. Basic Permissions. 143 | 144 | All rights granted under this License are granted for the term of 145 | copyright on the Program, and are irrevocable provided the stated 146 | conditions are met. This License explicitly affirms your unlimited 147 | permission to run the unmodified Program. The output from running a 148 | covered work is covered by this License only if the output, given its 149 | content, constitutes a covered work. This License acknowledges your 150 | rights of fair use or other equivalent, as provided by copyright law. 151 | 152 | You may make, run and propagate covered works that you do not 153 | convey, without conditions so long as your license otherwise remains 154 | in force. You may convey covered works to others for the sole purpose 155 | of having them make modifications exclusively for you, or provide you 156 | with facilities for running those works, provided that you comply with 157 | the terms of this License in conveying all material for which you do 158 | not control copyright. Those thus making or running the covered works 159 | for you must do so exclusively on your behalf, under your direction 160 | and control, on terms that prohibit them from making any copies of 161 | your copyrighted material outside their relationship with you. 162 | 163 | Conveying under any other circumstances is permitted solely under 164 | the conditions stated below. Sublicensing is not allowed; section 10 165 | makes it unnecessary. 166 | 167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 168 | 169 | No covered work shall be deemed part of an effective technological 170 | measure under any applicable law fulfilling obligations under article 171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 172 | similar laws prohibiting or restricting circumvention of such 173 | measures. 174 | 175 | When you convey a covered work, you waive any legal power to forbid 176 | circumvention of technological measures to the extent such circumvention 177 | is effected by exercising rights under this License with respect to 178 | the covered work, and you disclaim any intention to limit operation or 179 | modification of the work as a means of enforcing, against the work's 180 | users, your or third parties' legal rights to forbid circumvention of 181 | technological measures. 182 | 183 | 4. Conveying Verbatim Copies. 184 | 185 | You may convey verbatim copies of the Program's source code as you 186 | receive it, in any medium, provided that you conspicuously and 187 | appropriately publish on each copy an appropriate copyright notice; 188 | keep intact all notices stating that this License and any 189 | non-permissive terms added in accord with section 7 apply to the code; 190 | keep intact all notices of the absence of any warranty; and give all 191 | recipients a copy of this License along with the Program. 192 | 193 | You may charge any price or no price for each copy that you convey, 194 | and you may offer support or warranty protection for a fee. 195 | 196 | 5. Conveying Modified Source Versions. 197 | 198 | You may convey a work based on the Program, or the modifications to 199 | produce it from the Program, in the form of source code under the 200 | terms of section 4, provided that you also meet all of these conditions: 201 | 202 | a) The work must carry prominent notices stating that you modified 203 | it, and giving a relevant date. 204 | 205 | b) The work must carry prominent notices stating that it is 206 | released under this License and any conditions added under section 207 | 7. This requirement modifies the requirement in section 4 to 208 | "keep intact all notices". 209 | 210 | c) You must license the entire work, as a whole, under this 211 | License to anyone who comes into possession of a copy. This 212 | License will therefore apply, along with any applicable section 7 213 | additional terms, to the whole of the work, and all its parts, 214 | regardless of how they are packaged. This License gives no 215 | permission to license the work in any other way, but it does not 216 | invalidate such permission if you have separately received it. 217 | 218 | d) If the work has interactive user interfaces, each must display 219 | Appropriate Legal Notices; however, if the Program has interactive 220 | interfaces that do not display Appropriate Legal Notices, your 221 | work need not make them do so. 222 | 223 | A compilation of a covered work with other separate and independent 224 | works, which are not by their nature extensions of the covered work, 225 | and which are not combined with it such as to form a larger program, 226 | in or on a volume of a storage or distribution medium, is called an 227 | "aggregate" if the compilation and its resulting copyright are not 228 | used to limit the access or legal rights of the compilation's users 229 | beyond what the individual works permit. Inclusion of a covered work 230 | in an aggregate does not cause this License to apply to the other 231 | parts of the aggregate. 232 | 233 | 6. Conveying Non-Source Forms. 234 | 235 | You may convey a covered work in object code form under the terms 236 | of sections 4 and 5, provided that you also convey the 237 | machine-readable Corresponding Source under the terms of this License, 238 | in one of these ways: 239 | 240 | a) Convey the object code in, or embodied in, a physical product 241 | (including a physical distribution medium), accompanied by the 242 | Corresponding Source fixed on a durable physical medium 243 | customarily used for software interchange. 244 | 245 | b) Convey the object code in, or embodied in, a physical product 246 | (including a physical distribution medium), accompanied by a 247 | written offer, valid for at least three years and valid for as 248 | long as you offer spare parts or customer support for that product 249 | model, to give anyone who possesses the object code either (1) a 250 | copy of the Corresponding Source for all the software in the 251 | product that is covered by this License, on a durable physical 252 | medium customarily used for software interchange, for a price no 253 | more than your reasonable cost of physically performing this 254 | conveying of source, or (2) access to copy the 255 | Corresponding Source from a network server at no charge. 256 | 257 | c) Convey individual copies of the object code with a copy of the 258 | written offer to provide the Corresponding Source. This 259 | alternative is allowed only occasionally and noncommercially, and 260 | only if you received the object code with such an offer, in accord 261 | with subsection 6b. 262 | 263 | d) Convey the object code by offering access from a designated 264 | place (gratis or for a charge), and offer equivalent access to the 265 | Corresponding Source in the same way through the same place at no 266 | further charge. You need not require recipients to copy the 267 | Corresponding Source along with the object code. If the place to 268 | copy the object code is a network server, the Corresponding Source 269 | may be on a different server (operated by you or a third party) 270 | that supports equivalent copying facilities, provided you maintain 271 | clear directions next to the object code saying where to find the 272 | Corresponding Source. Regardless of what server hosts the 273 | Corresponding Source, you remain obligated to ensure that it is 274 | available for as long as needed to satisfy these requirements. 275 | 276 | e) Convey the object code using peer-to-peer transmission, provided 277 | you inform other peers where the object code and Corresponding 278 | Source of the work are being offered to the general public at no 279 | charge under subsection 6d. 280 | 281 | A separable portion of the object code, whose source code is excluded 282 | from the Corresponding Source as a System Library, need not be 283 | included in conveying the object code work. 284 | 285 | A "User Product" is either (1) a "consumer product", which means any 286 | tangible personal property which is normally used for personal, family, 287 | or household purposes, or (2) anything designed or sold for incorporation 288 | into a dwelling. In determining whether a product is a consumer product, 289 | doubtful cases shall be resolved in favor of coverage. For a particular 290 | product received by a particular user, "normally used" refers to a 291 | typical or common use of that class of product, regardless of the status 292 | of the particular user or of the way in which the particular user 293 | actually uses, or expects or is expected to use, the product. A product 294 | is a consumer product regardless of whether the product has substantial 295 | commercial, industrial or non-consumer uses, unless such uses represent 296 | the only significant mode of use of the product. 297 | 298 | "Installation Information" for a User Product means any methods, 299 | procedures, authorization keys, or other information required to install 300 | and execute modified versions of a covered work in that User Product from 301 | a modified version of its Corresponding Source. The information must 302 | suffice to ensure that the continued functioning of the modified object 303 | code is in no case prevented or interfered with solely because 304 | modification has been made. 305 | 306 | If you convey an object code work under this section in, or with, or 307 | specifically for use in, a User Product, and the conveying occurs as 308 | part of a transaction in which the right of possession and use of the 309 | User Product is transferred to the recipient in perpetuity or for a 310 | fixed term (regardless of how the transaction is characterized), the 311 | Corresponding Source conveyed under this section must be accompanied 312 | by the Installation Information. But this requirement does not apply 313 | if neither you nor any third party retains the ability to install 314 | modified object code on the User Product (for example, the work has 315 | been installed in ROM). 316 | 317 | The requirement to provide Installation Information does not include a 318 | requirement to continue to provide support service, warranty, or updates 319 | for a work that has been modified or installed by the recipient, or for 320 | the User Product in which it has been modified or installed. Access to a 321 | network may be denied when the modification itself materially and 322 | adversely affects the operation of the network or violates the rules and 323 | protocols for communication across the network. 324 | 325 | Corresponding Source conveyed, and Installation Information provided, 326 | in accord with this section must be in a format that is publicly 327 | documented (and with an implementation available to the public in 328 | source code form), and must require no special password or key for 329 | unpacking, reading or copying. 330 | 331 | 7. Additional Terms. 332 | 333 | "Additional permissions" are terms that supplement the terms of this 334 | License by making exceptions from one or more of its conditions. 335 | Additional permissions that are applicable to the entire Program shall 336 | be treated as though they were included in this License, to the extent 337 | that they are valid under applicable law. If additional permissions 338 | apply only to part of the Program, that part may be used separately 339 | under those permissions, but the entire Program remains governed by 340 | this License without regard to the additional permissions. 341 | 342 | When you convey a copy of a covered work, you may at your option 343 | remove any additional permissions from that copy, or from any part of 344 | it. (Additional permissions may be written to require their own 345 | removal in certain cases when you modify the work.) You may place 346 | additional permissions on material, added by you to a covered work, 347 | for which you have or can give appropriate copyright permission. 348 | 349 | Notwithstanding any other provision of this License, for material you 350 | add to a covered work, you may (if authorized by the copyright holders of 351 | that material) supplement the terms of this License with terms: 352 | 353 | a) Disclaiming warranty or limiting liability differently from the 354 | terms of sections 15 and 16 of this License; or 355 | 356 | b) Requiring preservation of specified reasonable legal notices or 357 | author attributions in that material or in the Appropriate Legal 358 | Notices displayed by works containing it; or 359 | 360 | c) Prohibiting misrepresentation of the origin of that material, or 361 | requiring that modified versions of such material be marked in 362 | reasonable ways as different from the original version; or 363 | 364 | d) Limiting the use for publicity purposes of names of licensors or 365 | authors of the material; or 366 | 367 | e) Declining to grant rights under trademark law for use of some 368 | trade names, trademarks, or service marks; or 369 | 370 | f) Requiring indemnification of licensors and authors of that 371 | material by anyone who conveys the material (or modified versions of 372 | it) with contractual assumptions of liability to the recipient, for 373 | any liability that these contractual assumptions directly impose on 374 | those licensors and authors. 375 | 376 | All other non-permissive additional terms are considered "further 377 | restrictions" within the meaning of section 10. If the Program as you 378 | received it, or any part of it, contains a notice stating that it is 379 | governed by this License along with a term that is a further 380 | restriction, you may remove that term. If a license document contains 381 | a further restriction but permits relicensing or conveying under this 382 | License, you may add to a covered work material governed by the terms 383 | of that license document, provided that the further restriction does 384 | not survive such relicensing or conveying. 385 | 386 | If you add terms to a covered work in accord with this section, you 387 | must place, in the relevant source files, a statement of the 388 | additional terms that apply to those files, or a notice indicating 389 | where to find the applicable terms. 390 | 391 | Additional terms, permissive or non-permissive, may be stated in the 392 | form of a separately written license, or stated as exceptions; 393 | the above requirements apply either way. 394 | 395 | 8. Termination. 396 | 397 | You may not propagate or modify a covered work except as expressly 398 | provided under this License. Any attempt otherwise to propagate or 399 | modify it is void, and will automatically terminate your rights under 400 | this License (including any patent licenses granted under the third 401 | paragraph of section 11). 402 | 403 | However, if you cease all violation of this License, then your 404 | license from a particular copyright holder is reinstated (a) 405 | provisionally, unless and until the copyright holder explicitly and 406 | finally terminates your license, and (b) permanently, if the copyright 407 | holder fails to notify you of the violation by some reasonable means 408 | prior to 60 days after the cessation. 409 | 410 | Moreover, your license from a particular copyright holder is 411 | reinstated permanently if the copyright holder notifies you of the 412 | violation by some reasonable means, this is the first time you have 413 | received notice of violation of this License (for any work) from that 414 | copyright holder, and you cure the violation prior to 30 days after 415 | your receipt of the notice. 416 | 417 | Termination of your rights under this section does not terminate the 418 | licenses of parties who have received copies or rights from you under 419 | this License. If your rights have been terminated and not permanently 420 | reinstated, you do not qualify to receive new licenses for the same 421 | material under section 10. 422 | 423 | 9. Acceptance Not Required for Having Copies. 424 | 425 | You are not required to accept this License in order to receive or 426 | run a copy of the Program. Ancillary propagation of a covered work 427 | occurring solely as a consequence of using peer-to-peer transmission 428 | to receive a copy likewise does not require acceptance. However, 429 | nothing other than this License grants you permission to propagate or 430 | modify any covered work. These actions infringe copyright if you do 431 | not accept this License. Therefore, by modifying or propagating a 432 | covered work, you indicate your acceptance of this License to do so. 433 | 434 | 10. Automatic Licensing of Downstream Recipients. 435 | 436 | Each time you convey a covered work, the recipient automatically 437 | receives a license from the original licensors, to run, modify and 438 | propagate that work, subject to this License. You are not responsible 439 | for enforcing compliance by third parties with this License. 440 | 441 | An "entity transaction" is a transaction transferring control of an 442 | organization, or substantially all assets of one, or subdividing an 443 | organization, or merging organizations. If propagation of a covered 444 | work results from an entity transaction, each party to that 445 | transaction who receives a copy of the work also receives whatever 446 | licenses to the work the party's predecessor in interest had or could 447 | give under the previous paragraph, plus a right to possession of the 448 | Corresponding Source of the work from the predecessor in interest, if 449 | the predecessor has it or can get it with reasonable efforts. 450 | 451 | You may not impose any further restrictions on the exercise of the 452 | rights granted or affirmed under this License. For example, you may 453 | not impose a license fee, royalty, or other charge for exercise of 454 | rights granted under this License, and you may not initiate litigation 455 | (including a cross-claim or counterclaim in a lawsuit) alleging that 456 | any patent claim is infringed by making, using, selling, offering for 457 | sale, or importing the Program or any portion of it. 458 | 459 | 11. Patents. 460 | 461 | A "contributor" is a copyright holder who authorizes use under this 462 | License of the Program or a work on which the Program is based. The 463 | work thus licensed is called the contributor's "contributor version". 464 | 465 | A contributor's "essential patent claims" are all patent claims 466 | owned or controlled by the contributor, whether already acquired or 467 | hereafter acquired, that would be infringed by some manner, permitted 468 | by this License, of making, using, or selling its contributor version, 469 | but do not include claims that would be infringed only as a 470 | consequence of further modification of the contributor version. For 471 | purposes of this definition, "control" includes the right to grant 472 | patent sublicenses in a manner consistent with the requirements of 473 | this License. 474 | 475 | Each contributor grants you a non-exclusive, worldwide, royalty-free 476 | patent license under the contributor's essential patent claims, to 477 | make, use, sell, offer for sale, import and otherwise run, modify and 478 | propagate the contents of its contributor version. 479 | 480 | In the following three paragraphs, a "patent license" is any express 481 | agreement or commitment, however denominated, not to enforce a patent 482 | (such as an express permission to practice a patent or covenant not to 483 | sue for patent infringement). To "grant" such a patent license to a 484 | party means to make such an agreement or commitment not to enforce a 485 | patent against the party. 486 | 487 | If you convey a covered work, knowingly relying on a patent license, 488 | and the Corresponding Source of the work is not available for anyone 489 | to copy, free of charge and under the terms of this License, through a 490 | publicly available network server or other readily accessible means, 491 | then you must either (1) cause the Corresponding Source to be so 492 | available, or (2) arrange to deprive yourself of the benefit of the 493 | patent license for this particular work, or (3) arrange, in a manner 494 | consistent with the requirements of this License, to extend the patent 495 | license to downstream recipients. "Knowingly relying" means you have 496 | actual knowledge that, but for the patent license, your conveying the 497 | covered work in a country, or your recipient's use of the covered work 498 | in a country, would infringe one or more identifiable patents in that 499 | country that you have reason to believe are valid. 500 | 501 | If, pursuant to or in connection with a single transaction or 502 | arrangement, you convey, or propagate by procuring conveyance of, a 503 | covered work, and grant a patent license to some of the parties 504 | receiving the covered work authorizing them to use, propagate, modify 505 | or convey a specific copy of the covered work, then the patent license 506 | you grant is automatically extended to all recipients of the covered 507 | work and works based on it. 508 | 509 | A patent license is "discriminatory" if it does not include within 510 | the scope of its coverage, prohibits the exercise of, or is 511 | conditioned on the non-exercise of one or more of the rights that are 512 | specifically granted under this License. You may not convey a covered 513 | work if you are a party to an arrangement with a third party that is 514 | in the business of distributing software, under which you make payment 515 | to the third party based on the extent of your activity of conveying 516 | the work, and under which the third party grants, to any of the 517 | parties who would receive the covered work from you, a discriminatory 518 | patent license (a) in connection with copies of the covered work 519 | conveyed by you (or copies made from those copies), or (b) primarily 520 | for and in connection with specific products or compilations that 521 | contain the covered work, unless you entered into that arrangement, 522 | or that patent license was granted, prior to 28 March 2007. 523 | 524 | Nothing in this License shall be construed as excluding or limiting 525 | any implied license or other defenses to infringement that may 526 | otherwise be available to you under applicable patent law. 527 | 528 | 12. No Surrender of Others' Freedom. 529 | 530 | If conditions are imposed on you (whether by court order, agreement or 531 | otherwise) that contradict the conditions of this License, they do not 532 | excuse you from the conditions of this License. If you cannot convey a 533 | covered work so as to satisfy simultaneously your obligations under this 534 | License and any other pertinent obligations, then as a consequence you may 535 | not convey it at all. For example, if you agree to terms that obligate you 536 | to collect a royalty for further conveying from those to whom you convey 537 | the Program, the only way you could satisfy both those terms and this 538 | License would be to refrain entirely from conveying the Program. 539 | 540 | 13. Remote Network Interaction; Use with the GNU General Public License. 541 | 542 | Notwithstanding any other provision of this License, if you modify the 543 | Program, your modified version must prominently offer all users 544 | interacting with it remotely through a computer network (if your version 545 | supports such interaction) an opportunity to receive the Corresponding 546 | Source of your version by providing access to the Corresponding Source 547 | from a network server at no charge, through some standard or customary 548 | means of facilitating copying of software. This Corresponding Source 549 | shall include the Corresponding Source for any work covered by version 3 550 | of the GNU General Public License that is incorporated pursuant to the 551 | following paragraph. 552 | 553 | Notwithstanding any other provision of this License, you have 554 | permission to link or combine any covered work with a work licensed 555 | under version 3 of the GNU General Public License into a single 556 | combined work, and to convey the resulting work. The terms of this 557 | License will continue to apply to the part which is the covered work, 558 | but the work with which it is combined will remain governed by version 559 | 3 of the GNU General Public License. 560 | 561 | 14. Revised Versions of this License. 562 | 563 | The Free Software Foundation may publish revised and/or new versions of 564 | the GNU Affero General Public License from time to time. Such new versions 565 | will be similar in spirit to the present version, but may differ in detail to 566 | address new problems or concerns. 567 | 568 | Each version is given a distinguishing version number. If the 569 | Program specifies that a certain numbered version of the GNU Affero General 570 | Public License "or any later version" applies to it, you have the 571 | option of following the terms and conditions either of that numbered 572 | version or of any later version published by the Free Software 573 | Foundation. If the Program does not specify a version number of the 574 | GNU Affero General Public License, you may choose any version ever published 575 | by the Free Software Foundation. 576 | 577 | If the Program specifies that a proxy can decide which future 578 | versions of the GNU Affero General Public License can be used, that proxy's 579 | public statement of acceptance of a version permanently authorizes you 580 | to choose that version for the Program. 581 | 582 | Later license versions may give you additional or different 583 | permissions. However, no additional obligations are imposed on any 584 | author or copyright holder as a result of your choosing to follow a 585 | later version. 586 | 587 | 15. Disclaimer of Warranty. 588 | 589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 597 | 598 | 16. Limitation of Liability. 599 | 600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 608 | SUCH DAMAGES. 609 | 610 | 17. Interpretation of Sections 15 and 16. 611 | 612 | If the disclaimer of warranty and limitation of liability provided 613 | above cannot be given local legal effect according to their terms, 614 | reviewing courts shall apply local law that most closely approximates 615 | an absolute waiver of all civil liability in connection with the 616 | Program, unless a warranty or assumption of liability accompanies a 617 | copy of the Program in return for a fee. 618 | 619 | END OF TERMS AND CONDITIONS 620 | 621 | How to Apply These Terms to Your New Programs 622 | 623 | If you develop a new program, and you want it to be of the greatest 624 | possible use to the public, the best way to achieve this is to make it 625 | free software which everyone can redistribute and change under these terms. 626 | 627 | To do so, attach the following notices to the program. It is safest 628 | to attach them to the start of each source file to most effectively 629 | state the exclusion of warranty; and each file should have at least 630 | the "copyright" line and a pointer to where the full notice is found. 631 | 632 | 633 | Copyright (C) 634 | 635 | This program is free software: you can redistribute it and/or modify 636 | it under the terms of the GNU Affero General Public License as published 637 | by the Free Software Foundation, either version 3 of the License, or 638 | (at your option) any later version. 639 | 640 | This program is distributed in the hope that it will be useful, 641 | but WITHOUT ANY WARRANTY; without even the implied warranty of 642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 643 | GNU Affero General Public License for more details. 644 | 645 | You should have received a copy of the GNU Affero General Public License 646 | along with this program. If not, see . 647 | 648 | Also add information on how to contact you by electronic and paper mail. 649 | 650 | If your software can interact with users remotely through a computer 651 | network, you should also make sure that it provides a way for users to 652 | get its source. For example, if your program is a web application, its 653 | interface could display a "Source" link that leads users to an archive 654 | of the code. There are many ways you could offer source, and different 655 | solutions will be better for different programs; see section 13 for the 656 | specific requirements. 657 | 658 | You should also get your employer (if you work as a programmer) or school, 659 | if any, to sign a "copyright disclaimer" for the program, if necessary. 660 | For more information on this, and how to apply and follow the GNU AGPL, see 661 | . 662 | --------------------------------------------------------------------------------