├── .docker ├── config │ ├── mysql │ │ └── config.cnf │ └── php │ │ ├── nextcloud.ini │ │ └── xdebug.ini ├── Dockerfile.nginx ├── bin │ └── occ ├── scripts │ ├── wait-for-db.php │ └── entrypoint.sh ├── Dockerfile.php81 ├── Dockerfile.php82 ├── Dockerfile.php83 └── nginx │ └── nginx.conf ├── .gitignore ├── .github ├── dependabot.yml └── workflows │ ├── shellcheck.yml │ ├── docker-nginx.yml │ └── docker-php.yml ├── docs ├── advanced-setup.md ├── apps-development.md ├── bash_aliases.md └── faq.md ├── README.md ├── docker-compose.yml └── LICENSE /.docker/config/mysql/config.cnf: -------------------------------------------------------------------------------- 1 | [mysqld] 2 | innodb_file_per_table=ON -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # IDE 2 | .vscode 3 | .idea 4 | 5 | # Docker volumes 6 | /volumes 7 | 8 | .env -------------------------------------------------------------------------------- /.docker/Dockerfile.nginx: -------------------------------------------------------------------------------- 1 | FROM nginx:alpine 2 | 3 | COPY nginx/nginx.conf /etc/nginx/nginx.conf -------------------------------------------------------------------------------- /.docker/config/php/nextcloud.ini: -------------------------------------------------------------------------------- 1 | post_max_size=512M 2 | upload_max_filesize=512M 3 | memory_limit=1024M 4 | apc.enable_cli=1 5 | -------------------------------------------------------------------------------- /.docker/config/php/xdebug.ini: -------------------------------------------------------------------------------- 1 | xdebug.client_host=host.docker.internal 2 | xdebug.discover_client_host=true 3 | xdebug.log_level=0 4 | xdebug.mode=debug 5 | xdebug.start_with_request=yes 6 | -------------------------------------------------------------------------------- /.docker/bin/occ: -------------------------------------------------------------------------------- 1 | #!/bin/sh 2 | 3 | if [ "$(whoami)" = "www-data" ]; then 4 | # shellcheck disable=SC2068 5 | /var/www/html/occ $@ 6 | else 7 | # shellcheck disable=SC2068 8 | runuser -u www-data -- /var/www/html/occ $@ 9 | fi 10 | -------------------------------------------------------------------------------- /.github/dependabot.yml: -------------------------------------------------------------------------------- 1 | version: 2 2 | updates: 3 | 4 | - package-ecosystem: "github-actions" 5 | directory: "/" 6 | schedule: 7 | interval: "daily" 8 | - package-ecosystem: "docker" 9 | directory: "/.docker/" 10 | schedule: 11 | interval: "daily" 12 | -------------------------------------------------------------------------------- /.github/workflows/shellcheck.yml: -------------------------------------------------------------------------------- 1 | on: 2 | pull_request: 3 | push: 4 | branches: 5 | - main 6 | 7 | name: 'Shellcheck' 8 | 9 | jobs: 10 | shellcheck: 11 | name: Shellcheck 12 | runs-on: ubuntu-latest 13 | steps: 14 | - uses: actions/checkout@v5 15 | - name: Run ShellCheck 16 | uses: ludeeus/action-shellcheck@master 17 | with: 18 | scandir: .docker/ 19 | -------------------------------------------------------------------------------- /docs/advanced-setup.md: -------------------------------------------------------------------------------- 1 | # Advanced setup 2 | 3 | ## Environments 4 | 5 | You can customize the environment before first run changing some environments entries. 6 | 7 | Create an `.env` file and add values on your needs. 8 | 9 | `VERSION_NEXTCLOUD` To this environment recommend to use the branch `master`. If you need to work with old version of server, use other branch of [Nextcloud server repository](https://github.com/nextcloud/server). 10 | 11 | ## PHP custom settings 12 | 13 | Custom PHP settings have to be applied on [`.docker/app/config/php.ini`](/.docker/app/config/php.ini) file. 14 | 15 | ⬅️ [Back to index](../README.md) 16 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Nextcloud development environment 2 | 3 | An development apps environment for Nextcloud. 4 | 5 | ## Development environment 6 | 7 | Run the command: 8 | 9 | ```bash 10 | docker compose up nextcloud mysql nginx mailhog redis 11 | ``` 12 | 13 | * [Advanced setup](docs/advanced-setup.md) 14 | * [Environments](docs/advanced-setup.md#environments) 15 | * [PHP custom settings](docs/advanced-setup.md#php-custom-settings) 16 | * [App development](docs/apps-development.md) 17 | * [Sample](docs/apps-development.md#samble) 18 | * [FAQ](docs/faq.md) 19 | * [Reset setup](docs/faq.md#reset-setup) 20 | * [Upgrade to newest commits of server repository](docs/faq.md#upgrade-to-newest-commits-of-server-repository) 21 | * [Using IDE](docs/faq.md#using-ide) 22 | * [Fix permissions](docs/faq.md#fix-permissions) 23 | * [Simplify commands with alias](docs/bash_aliases.md) -------------------------------------------------------------------------------- /.docker/scripts/wait-for-db.php: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env php 2 | getMessage()."\n"; 21 | return false; 22 | } 23 | return true; 24 | } 25 | 26 | while(!dbIsUp($dbName)) { 27 | sleep(1); 28 | } 29 | 30 | echo "✅ Database $dbName ready\n"; -------------------------------------------------------------------------------- /docs/apps-development.md: -------------------------------------------------------------------------------- 1 | # Start development of apps 2 | 3 | You will need create (or clone) the folder of the app that you will work inside the folder `volumes/nextcloud/apps-extra`. 4 | 5 | It's not required install all dependencis like php or nodejs to develop apps, with this project is only use the bash in container to compile app. 6 | 7 | ## Sample 8 | 9 | Using the [LibreSign](https://github.com/LibreSign/libresign): 10 | 11 | To install LibreSign in the structure of develop is required [up servicer](#up-services). After nextcloud config and install. 12 | - open folder `volumes/nextcloud/app-extra` 13 | - clone project with `git clone https://github.com/LibreSign/libresign.git` 14 | - open bash in nextcloud container with `docker compose exec -u www-data nextcloud bash` 15 | - go to folder `apps-extra/libresign` 16 | ```bash 17 | cd apps-extra/libresign 18 | ``` 19 | - Now you can run all the necessaries commands to build the project, i.e: 20 | ```bash 21 | # download composer dependencies 22 | composer install 23 | # download JS dependencies 24 | npm ci 25 | # build and watch JS changes 26 | npm run watch 27 | ``` 28 | 29 | ⬅️ [Back to index](../README.md) 30 | -------------------------------------------------------------------------------- /docs/bash_aliases.md: -------------------------------------------------------------------------------- 1 | # ~/.bash aliases 2 | 3 | With an alias you can simplify the execution of big and complex commands assigning an alias to the big command and using the alias as a new command. 4 | 5 | Bash alias is often defined in `~/.bashrc` file. However, it is possible to use `~/.bash_aliases` file too on certain Linux distros. 6 | 7 | You may want to put all your additions into a separate file like `~/.bash_aliases`, instead of adding them directly to ~/.bashrc file. 8 | 9 | ## Calling ~/bash aliases 10 | 11 | The ~/.bash_aliases must be called by your $HOME/.bashrc file as follows: 12 | 13 | ```bash 14 | if [ -f ~/.bash_aliases ]; then 15 | . ~/.bash_aliases 16 | fi 17 | ``` 18 | The `~/.bashrc` file is executed every when you start a new terminal session. If you don't want to start a new terminal, run the follow command to execute your changes: 19 | 20 | ```bash 21 | source ~/.bashrc 22 | ``` 23 | 24 | ## Sample ~/.bash_aliases file 25 | 26 | ```bash 27 | alias occ='docker compose exec -u www-data nextcloud occ' 28 | alias nextcloud-mysql='docker compose up nextcloud mysql nginx mailhog redis' 29 | alias nextcloud-pgsql='docker compose up nextcloud pgsql nginx mailhog redis' 30 | ``` 31 | 32 | ⬅️ [Back to index](../README.md) 33 | -------------------------------------------------------------------------------- /.docker/Dockerfile.php81: -------------------------------------------------------------------------------- 1 | FROM php:8.1-fpm 2 | 3 | RUN apt-get update \ 4 | && apt-get install -y \ 5 | busybox-static \ 6 | git \ 7 | jq \ 8 | libicu-dev \ 9 | libzip-dev \ 10 | locales \ 11 | poppler-utils \ 12 | procps \ 13 | unzip \ 14 | # cron 15 | && mkdir -p /var/spool/cron/crontabs \ 16 | && echo '*/5 * * * * php -f /var/www/html/cron.php' > /var/spool/cron/crontabs/www-data \ 17 | && sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen \ 18 | && locale-gen \ 19 | && rm -rf /var/lib/apt/lists/* 20 | 21 | ENV LANG=en_US.UTF-8 22 | ENV LANGUAGE=en_US:en 23 | ENV LC_ALL=en_US.UTF-8 24 | 25 | # Install PHP extensions 26 | ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/ 27 | RUN chmod uga+x /usr/local/bin/install-php-extensions && sync \ 28 | && install-php-extensions \ 29 | apcu \ 30 | bcmath \ 31 | bz2 \ 32 | exif \ 33 | gd \ 34 | gettext \ 35 | gmp \ 36 | imagick \ 37 | intl \ 38 | memcache \ 39 | memcached \ 40 | mysqli \ 41 | opcache \ 42 | pcntl \ 43 | pdo \ 44 | pdo_mysql \ 45 | pdo_pgsql \ 46 | pgsql \ 47 | redis \ 48 | sockets \ 49 | sodium \ 50 | sysvsem \ 51 | xdebug \ 52 | zip \ 53 | @composer \ 54 | && rm /usr/local/bin/install-php-extensions \ 55 | # pevent errors when try to create files at /var/www with user www-data 56 | && chown -R www-data /var/www 57 | 58 | # Install NVM 59 | RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash \ 60 | && export NVM_DIR="/root/.nvm" \ 61 | && . "$NVM_DIR/nvm.sh" \ 62 | && nvm install 20 \ 63 | && nvm alias default 20 64 | 65 | COPY config/php/* /usr/local/etc/php/conf.d/ 66 | COPY scripts/* /var/www/scripts/ 67 | COPY bin/* /usr/local/bin/ 68 | 69 | VOLUME /var/www/html 70 | 71 | WORKDIR /var/www/html 72 | 73 | ENTRYPOINT [ "bash", "/var/www/scripts/entrypoint.sh" ] 74 | CMD ["php-fpm"] 75 | -------------------------------------------------------------------------------- /.docker/Dockerfile.php82: -------------------------------------------------------------------------------- 1 | FROM php:8.2-fpm 2 | 3 | RUN apt-get update \ 4 | && apt-get install -y \ 5 | busybox-static \ 6 | git \ 7 | jq \ 8 | libicu-dev \ 9 | libzip-dev \ 10 | locales \ 11 | poppler-utils \ 12 | procps \ 13 | unzip \ 14 | # cron 15 | && mkdir -p /var/spool/cron/crontabs \ 16 | && echo '*/5 * * * * php -f /var/www/html/cron.php' > /var/spool/cron/crontabs/www-data \ 17 | && sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen \ 18 | && locale-gen \ 19 | && rm -rf /var/lib/apt/lists/* 20 | 21 | ENV LANG=en_US.UTF-8 22 | ENV LANGUAGE=en_US:en 23 | ENV LC_ALL=en_US.UTF-8 24 | 25 | # Install PHP extensions 26 | ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/ 27 | RUN chmod uga+x /usr/local/bin/install-php-extensions && sync \ 28 | && install-php-extensions \ 29 | apcu \ 30 | bcmath \ 31 | bz2 \ 32 | exif \ 33 | gd \ 34 | gettext \ 35 | gmp \ 36 | imagick \ 37 | intl \ 38 | memcache \ 39 | memcached \ 40 | mysqli \ 41 | opcache \ 42 | pcntl \ 43 | pdo \ 44 | pdo_mysql \ 45 | pdo_pgsql \ 46 | pgsql \ 47 | redis \ 48 | sockets \ 49 | sodium \ 50 | sysvsem \ 51 | xdebug \ 52 | zip \ 53 | @composer \ 54 | && rm /usr/local/bin/install-php-extensions \ 55 | # pevent errors when try to create files at /var/www with user www-data 56 | && chown -R www-data /var/www 57 | 58 | # Install NVM 59 | RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash \ 60 | && export NVM_DIR="/root/.nvm" \ 61 | && . "$NVM_DIR/nvm.sh" \ 62 | && nvm install 20 \ 63 | && nvm alias default 20 64 | 65 | COPY config/php/* /usr/local/etc/php/conf.d/ 66 | COPY scripts/* /var/www/scripts/ 67 | COPY bin/* /usr/local/bin/ 68 | 69 | VOLUME /var/www/html 70 | 71 | WORKDIR /var/www/html 72 | 73 | ENTRYPOINT [ "bash", "/var/www/scripts/entrypoint.sh" ] 74 | CMD ["php-fpm"] 75 | -------------------------------------------------------------------------------- /.docker/Dockerfile.php83: -------------------------------------------------------------------------------- 1 | FROM php:8.3-fpm 2 | 3 | RUN apt-get update \ 4 | && apt-get install -y \ 5 | busybox-static \ 6 | git \ 7 | jq \ 8 | libicu-dev \ 9 | libzip-dev \ 10 | locales \ 11 | poppler-utils \ 12 | procps \ 13 | unzip \ 14 | # cron 15 | && mkdir -p /var/spool/cron/crontabs \ 16 | && echo '*/5 * * * * php -f /var/www/html/cron.php' > /var/spool/cron/crontabs/www-data \ 17 | && sed -i -e 's/# en_US.UTF-8 UTF-8/en_US.UTF-8 UTF-8/' /etc/locale.gen \ 18 | && locale-gen \ 19 | && rm -rf /var/lib/apt/lists/* 20 | 21 | ENV LANG=en_US.UTF-8 22 | ENV LANGUAGE=en_US:en 23 | ENV LC_ALL=en_US.UTF-8 24 | 25 | # Install PHP extensions 26 | ADD https://github.com/mlocati/docker-php-extension-installer/releases/latest/download/install-php-extensions /usr/local/bin/ 27 | RUN chmod uga+x /usr/local/bin/install-php-extensions && sync \ 28 | && install-php-extensions \ 29 | apcu \ 30 | bcmath \ 31 | bz2 \ 32 | exif \ 33 | gd \ 34 | gettext \ 35 | gmp \ 36 | imagick \ 37 | intl \ 38 | memcache \ 39 | memcached \ 40 | mysqli \ 41 | opcache \ 42 | pcntl \ 43 | pdo \ 44 | pdo_mysql \ 45 | pdo_pgsql \ 46 | pgsql \ 47 | redis \ 48 | sockets \ 49 | sodium \ 50 | sysvsem \ 51 | xdebug \ 52 | zip \ 53 | @composer \ 54 | && rm /usr/local/bin/install-php-extensions \ 55 | # pevent errors when try to create files at /var/www with user www-data 56 | && chown -R www-data /var/www 57 | 58 | # Install NVM 59 | RUN curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash \ 60 | && export NVM_DIR="/root/.nvm" \ 61 | && . "$NVM_DIR/nvm.sh" \ 62 | && nvm install 20 \ 63 | && nvm alias default 20 64 | 65 | COPY config/php/* /usr/local/etc/php/conf.d/ 66 | COPY scripts/* /var/www/scripts/ 67 | COPY bin/* /usr/local/bin/ 68 | 69 | VOLUME /var/www/html 70 | 71 | WORKDIR /var/www/html 72 | 73 | ENTRYPOINT [ "bash", "/var/www/scripts/entrypoint.sh" ] 74 | CMD ["php-fpm"] 75 | -------------------------------------------------------------------------------- /docs/faq.md: -------------------------------------------------------------------------------- 1 | # FAQ 2 | 3 | ## Reset setup 4 | 5 | ### Reset entire setup? 6 | 7 | - Go down the containers 8 | - Remove the folder volumes 9 | - Go up the containers 10 | 11 | This will delete the database and Nextcloud volumes. Before do a backup of all that you don't want to lost, by example `volumes/nextcloud/config/config.php` 12 | 13 | ## Upgrade to newest commits of server repository 14 | 15 | - ```bash 16 | cd volumes/nextcloud 17 | git pull origin master 18 | ``` 19 | 20 | ## Using IDE 21 | ### Workspace folder 22 | 23 | - To work with PHP, I recommend to open your IDE in folder `volumes/nextcloud` 24 | - To work only with frontend, you can directly open the folder of app that you are working but I recommend to open the folder `volumes/nextcloud` to be possible look the code of other apps or server. 25 | 26 | ### Xdebug on VSCode or Codium 27 | #### Configuring environment 28 | - Create a .env file at root folder with this content: 29 | ```env 30 | XDEBUG_CONFIG=client_host=172.17.0.1 client_port=9003 start_with_request=yes 31 | ``` 32 | #### Configuring IDE 33 | - Open the IDE on folder `volumes/nextcloud` 34 | - setup the extension [PHP Debug](https://marketplace.visualstudio.com/items?itemName=xdebug.php-debug) or [PHP Extension Pack](https://marketplace.visualstudio.com/items?itemName=xdebug.php-pack) 35 | - Press `F5` to start debugging or go to "`Run > Start debugging`" 36 | - Create a `launch.json` file to PHP 37 | - Add the follow to your `launch.json` inside configuration named as `Listen for Xdebug`: 38 | ```json 39 | "pathMappings": { 40 | "/var/www/html": "${workspaceFolder}" 41 | } 42 | ``` 43 | - **PS**: [`log_level`](https://xdebug.org/docs/all_settings#log_level) is defined to 0 (Criticals). If you wish a different value, ghante this at `.env` file. 44 | 45 | ## Fix permissions 46 | 47 | - The default user id (`UID`) and group id (`GID`) of root user inside container is the same of your user in host machine. This is defined in `.env` file. If is different of 1000 and 1000, change in your `.env` file. 48 | - Run the follow command to move all files to your UID and GID: 49 | ```bash 50 | sudo chown -R $USER:$USER volumes/nextcloud 51 | ``` 52 | 53 | ⬅️ [Back to index](../README.md) 54 | -------------------------------------------------------------------------------- /.github/workflows/docker-nginx.yml: -------------------------------------------------------------------------------- 1 | name: 'Docker Nginx Publish' 2 | 3 | on: 4 | schedule: 5 | - cron: '0 2 * * *' 6 | pull_request: 7 | push: 8 | branches: 9 | - main 10 | 11 | concurrency: 12 | group: push-to-registry-${{ github.head_ref || github.run_id }} 13 | cancel-in-progress: true 14 | 15 | jobs: 16 | push_to_registry: 17 | name: Build image 18 | runs-on: ubuntu-latest 19 | permissions: 20 | packages: write 21 | contents: read 22 | steps: 23 | - name: Check out the repo 24 | uses: actions/checkout@v5 25 | - name: Set up QEMU 26 | uses: docker/setup-qemu-action@v3 27 | - name: Set up Docker Buildx 28 | uses: docker/setup-buildx-action@v3 29 | - name: Cache Docker layers 30 | uses: actions/cache@v4 31 | with: 32 | path: /tmp/.buildx-cache 33 | key: nginx-buildx-${{ github.sha }} 34 | restore-keys: | 35 | nginx-buildx- 36 | - name: Log in to GitHub Container Registry 37 | uses: docker/login-action@v3 38 | with: 39 | registry: ghcr.io 40 | username: ${{ github.actor }} 41 | password: ${{ secrets.GITHUB_TOKEN }} 42 | - name: Available platforms 43 | run: echo ${{ steps.buildx.outputs.platforms }} 44 | - name: Set dockerfile path 45 | id: dockerfile 46 | run: | 47 | DOCKERFILE=$(echo ".docker/Dockerfile.nginx") 48 | echo "DOCKERFILE=$DOCKERFILE" >> $GITHUB_OUTPUT 49 | - name: Build container image 50 | uses: docker/build-push-action@v6 51 | with: 52 | push: false 53 | context: .docker/ 54 | platforms: linux/amd64,linux/arm64 55 | file: ${{ steps.dockerfile.outputs.DOCKERFILE }} 56 | tags: | 57 | ghcr.io/librecodecoop/nextcloud-dev-nginx 58 | cache-from: type=local,src=/tmp/.buildx-cache 59 | cache-to: type=local,dest=/tmp/.buildx-cache-new 60 | - name: Push container image 61 | uses: docker/build-push-action@v6 62 | if: github.ref == 'refs/heads/main' 63 | with: 64 | push: true 65 | context: .docker/ 66 | platforms: linux/amd64,linux/arm64 67 | file: ${{ steps.dockerfile.outputs.DOCKERFILE }} 68 | tags: | 69 | ghcr.io/librecodecoop/nextcloud-dev-nginx 70 | cache-from: type=local,src=/tmp/.buildx-cache 71 | cache-to: type=local,dest=/tmp/.buildx-cache-new 72 | - name: Move cache 73 | run: | 74 | rm -rf /tmp/.buildx-cache 75 | mv /tmp/.buildx-cache-new /tmp/.buildx-cache 76 | 77 | 78 | -------------------------------------------------------------------------------- /docker-compose.yml: -------------------------------------------------------------------------------- 1 | services: 2 | pgsql: 3 | image: postgres:13-alpine 4 | restart: unless-stopped 5 | volumes: 6 | - ./volumes/postgres/data:/var/lib/postgresql/data 7 | environment: 8 | - POSTGRES_DB=${POSTGRES_DB:-nextcloud} 9 | - POSTGRES_USER=${POSTGRES_USER:-nextcloud} 10 | - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-nextcloud} 11 | ports: 12 | - 127.0.0.1:5432:5432 13 | command: postgres -c log_statement=all 14 | mysql: 15 | image: mysql 16 | volumes: 17 | - ./volumes/mysql/init:/docker-entrypoint-initdb.d 18 | - ./volumes/mysql/data:/var/lib/mysql 19 | ports: 20 | - 127.0.0.1:3306:3306 21 | restart: unless-stopped 22 | environment: 23 | - TZ=${TZ:-CET} 24 | - MYSQL_ROOT_PASSWORD=${MYSQL_ROOT_PASSWORD:-root} 25 | - MYSQL_DATABASE=${MYSQL_DATABASE:-nextcloud} 26 | - MYSQL_USER=${MYSQL_USER:-nextcloud} 27 | - MYSQL_PASSWORD=${MYSQL_PASSWORD:-nextcloud} 28 | nextcloud: 29 | image: ghcr.io/librecodecoop/nextcloud-dev-php${PHP_VERSION:-82}:latest 30 | # build: 31 | # context: .docker/ 32 | # dockerfile: Dockerfile.php${PHP_VERSION:-81} 33 | volumes: 34 | - ./.docker/scripts/wait-for-db.php:/var/www/scripts/wait-for-db.php 35 | - ~/.composer:/var/www/.composer/ 36 | - ~/.npm:/var/www/.npm/ 37 | - ./volumes/nextcloud:/var/www/html 38 | restart: unless-stopped 39 | environment: 40 | - HOST_UID=${HOST_UID:-1000} 41 | - HOST_GID=${HOST_GID:-1000} 42 | - DEFAULT_PHONE_REGION=${DEFAULT_PHONE_REGION:-UTC} 43 | - NEXTCLOUD_ADMIN_USER=${NEXTCLOUD_ADMIN_USER:-admin} 44 | - NEXTCLOUD_ADMIN_PASSWORD=${NEXTCLOUD_ADMIN_PASSWORD:-admin} 45 | - NEXTCLOUD_ADMIN_EMAIL=${NEXTCLOUD_ADMIN_EMAIL:-a@test.tld} 46 | - DB_HOST=${DB_HOST:-mysql} 47 | - MYSQL_DATABASE=${MYSQL_DATABASE:-nextcloud} 48 | - MYSQL_USER=${MYSQL_USER:-nextcloud} 49 | - MYSQL_PASSWORD=${MYSQL_PASSWORD:-nextcloud} 50 | - POSTGRES_DB=${POSTGRES_DB:-nextcloud} 51 | - POSTGRES_USER=${POSTGRES_USER:-nextcloud} 52 | - POSTGRES_PASSWORD=${POSTGRES_PASSWORD:-nextcloud} 53 | - MAIL_FROM_ADDRESS=${MAIL_FROM_ADDRESS:-nextcloud} 54 | - MAIL_DOMAIN=${MAIL_DOMAIN:-nextcloud.test} 55 | - MAIL_SMTPPORT=${MAIL_SMTPPORT:-1025} 56 | - MAIL_SMTPHOST=${MAIL_SMTPHOST:-mailhog} 57 | - VERSION_NEXTCLOUD=${VERSION_NEXTCLOUD:-master} 58 | - AUTOINSTALL=${AUTOINSTALL:-1} 59 | - XDEBUG_CONFIG 60 | - HTTP_PORT=${HTTP_PORT:-80} 61 | extra_hosts: 62 | - host.docker.internal:host-gateway 63 | nginx: 64 | image: ghcr.io/librecodecoop/nextcloud-dev-nginx:latest 65 | # build: .docker/nginx 66 | restart: unless-stopped 67 | volumes: 68 | - ./volumes/nextcloud:/var/www/html:ro 69 | - ./volumes/nginx/includes:/etc/nginx/conf.d/includes/ 70 | ports: 71 | - 127.0.0.1:${HTTP_PORT:-80}:80 72 | mailhog: 73 | image: blueimp/mailhog 74 | ports: 75 | - 127.0.0.1:${MAILHOG_PORT:-8025}:8025 76 | redis: 77 | image: redis 78 | 79 | -------------------------------------------------------------------------------- /.github/workflows/docker-php.yml: -------------------------------------------------------------------------------- 1 | name: 'Docker PHP Publish' 2 | 3 | on: 4 | schedule: 5 | - cron: '0 2 * * *' 6 | pull_request: 7 | push: 8 | branches: 9 | - main 10 | 11 | concurrency: 12 | group: push-to-registry-${{ github.head_ref || github.run_id }} 13 | cancel-in-progress: true 14 | 15 | jobs: 16 | push_to_registry: 17 | name: Build image 18 | runs-on: ubuntu-latest 19 | strategy: 20 | fail-fast: false 21 | matrix: 22 | container: 23 | - php81 24 | - php82 25 | - php83 26 | permissions: 27 | packages: write 28 | contents: read 29 | steps: 30 | - name: Check out the repo 31 | uses: actions/checkout@v5 32 | - name: Set up QEMU 33 | uses: docker/setup-qemu-action@v3 34 | - name: Set up Docker Buildx 35 | uses: docker/setup-buildx-action@v3 36 | - name: Cache Docker layers 37 | id: docker-cache 38 | uses: actions/cache@v4 39 | with: 40 | path: /tmp/.buildx-cache 41 | key: ${{ matrix.container }}-buildx-${{ github.sha }} 42 | restore-keys: | 43 | ${{ matrix.container }}-buildx- 44 | - name: Log in to GitHub Container Registry 45 | uses: docker/login-action@v3 46 | with: 47 | registry: ghcr.io 48 | username: ${{ github.actor }} 49 | password: ${{ secrets.GITHUB_TOKEN }} 50 | - name: Available platforms 51 | run: echo ${{ steps.buildx.outputs.platforms }} 52 | - name: Set dockerfile path 53 | id: dockerfile 54 | run: | 55 | NAME="${{ matrix.container }}" 56 | DOCKERFILE=$([[ -f ".docker/$NAME/Dockerfile" ]] && echo ".docker/$NAME/Dockerfile" || echo ".docker/Dockerfile.$NAME") 57 | echo "DOCKERFILE=$DOCKERFILE" >> $GITHUB_OUTPUT 58 | - name: Build container image 59 | uses: docker/build-push-action@v6 60 | with: 61 | push: false 62 | context: .docker/ 63 | platforms: linux/amd64,linux/arm64 64 | file: ${{ steps.dockerfile.outputs.DOCKERFILE }} 65 | tags: | 66 | ghcr.io/librecodecoop/nextcloud-dev-${{ matrix.container }}:${{ github.sha }} 67 | cache-from: type=local,src=/tmp/.buildx-cache 68 | cache-to: type=local,dest=/tmp/.buildx-cache-new 69 | - name: Push container image 70 | uses: docker/build-push-action@v6 71 | if: github.ref == 'refs/heads/main' 72 | with: 73 | push: true 74 | context: .docker/ 75 | platforms: linux/amd64,linux/arm64 76 | file: ${{ steps.dockerfile.outputs.DOCKERFILE }} 77 | tags: | 78 | ghcr.io/librecodecoop/nextcloud-dev-${{ matrix.container }}:${{ github.sha }} 79 | ghcr.io/librecodecoop/nextcloud-dev-${{ matrix.container }}:latest 80 | cache-from: type=local,src=/tmp/.buildx-cache 81 | cache-to: type=local,dest=/tmp/.buildx-cache-new 82 | - name: Move cache 83 | run: | 84 | rm -rf /tmp/.buildx-cache 85 | mv /tmp/.buildx-cache-new /tmp/.buildx-cache 86 | - name: Save Docker cache 87 | if: steps.docker-cache.outputs.cache-hit != 'true' 88 | uses: actions/cache@v4 89 | with: 90 | path: /tmp/.buildx-cache 91 | key: ${{ matrix.container }}-buildx-${{ github.sha }} 92 | -------------------------------------------------------------------------------- /.docker/scripts/entrypoint.sh: -------------------------------------------------------------------------------- 1 | #!/bin/bash 2 | 3 | # Set uid of host machine 4 | usermod --non-unique --uid "${HOST_UID}" www-data 5 | groupmod --non-unique --gid "${HOST_GID}" www-data 6 | 7 | # Clone Nextcloud repository, if needed 8 | if [ ! -d ".git" ]; then 9 | git config --global --add safe.directory /var/www/html 10 | git init 11 | git remote add origin https://github.com/nextcloud/server 12 | git fetch --depth=1 origin "${VERSION_NEXTCLOUD}" 13 | git checkout "${VERSION_NEXTCLOUD}" 14 | git submodule update --init --recursive 15 | fi 16 | 17 | mkdir -p data 18 | mkdir -p apps-writable 19 | mkdir -p config 20 | mkdir -p apps-extra 21 | 22 | # Wait for database 23 | php /var/www/scripts/wait-for-db.php 24 | 25 | # Set configurations, if needed 26 | if [[ ! -f "config/config.php" && ${AUTOINSTALL} -eq 1 ]]; then 27 | echo "⌛️ Starting installation ..." 28 | chown -R www-data:www-data . 29 | if [[ ${DB_HOST} == 'mysql' ]]; then 30 | occ maintenance:install --verbose --database="${DB_HOST}" --database-name="${MYSQL_DATABASE}" --database-host="${DB_HOST}" --database-port= --database-user="${MYSQL_USER}" --database-pass="${MYSQL_PASSWORD}" --admin-user="${NEXTCLOUD_ADMIN_USER}" --admin-pass="${NEXTCLOUD_ADMIN_PASSWORD}" --admin-email="${NEXTCLOUD_ADMIN_EMAIL}" 31 | elif [[ "${DB_HOST}" == 'pgsql' ]]; then 32 | occ maintenance:install --verbose --database="${DB_HOST}" --database-name="${POSTGRES_DB}" --database-host="${DB_HOST}" --database-port= --database-user="${POSTGRES_USER}" --database-pass="${POSTGRES_PASSWORD}" --admin-user="${NEXTCLOUD_ADMIN_USER}" --admin-pass="${NEXTCLOUD_ADMIN_PASSWORD}" --admin-email="${NEXTCLOUD_ADMIN_EMAIL}" 33 | else 34 | occ maintenance:install --verbose --admin-user="${NEXTCLOUD_ADMIN_USER}" --admin-pass="${NEXTCLOUD_ADMIN_PASSWORD}" --admin-email="${NEXTCLOUD_ADMIN_EMAIL}" 35 | fi 36 | 37 | echo "🔧 Making initial config ..." 38 | occ config:import < /dev/null 2>&1 & 106 | runuser -u www-data -- php -f /var/www/html/cron.php 107 | 108 | # Start PHP-FPM 109 | if [[ "$HTTP_PORT" != 80 ]]; then 110 | echo "💙 Nextclud is up! Access http://localhost:$HTTP_PORT" 111 | else 112 | echo "💙 Nextclud is up! Access http://localhost" 113 | fi 114 | exec "$@" 115 | -------------------------------------------------------------------------------- /.docker/nginx/nginx.conf: -------------------------------------------------------------------------------- 1 | worker_processes auto; 2 | 3 | error_log /var/log/nginx/error.log warn; 4 | pid /var/run/nginx.pid; 5 | 6 | 7 | events { 8 | worker_connections 1024; 9 | } 10 | 11 | http { 12 | disable_symlinks off; 13 | # Prevent nginx HTTP Server Detection 14 | server_tokens off; 15 | 16 | include /etc/nginx/mime.types; 17 | default_type application/octet-stream; 18 | 19 | log_format main '$remote_addr - $remote_user [$time_local] "$request" ' 20 | '$status $body_bytes_sent "$http_referer" ' 21 | '"$http_user_agent" "$http_x_forwarded_for"'; 22 | 23 | access_log /var/log/nginx/access.log main; 24 | 25 | sendfile on; 26 | #tcp_nopush on; 27 | 28 | keepalive_timeout 65; 29 | 30 | set_real_ip_from 10.0.0.0/8; 31 | set_real_ip_from 172.16.0.0/12; 32 | set_real_ip_from 192.168.0.0/16; 33 | real_ip_header X-Real-IP; 34 | 35 | #gzip on; 36 | 37 | upstream php-handler { 38 | server nextcloud:9000; 39 | } 40 | 41 | server { 42 | listen 80; 43 | include /etc/nginx/conf.d/includes/*.conf; 44 | 45 | # Add headers to serve security related headers 46 | # Before enabling Strict-Transport-Security headers please read into this 47 | # topic first. 48 | add_header Strict-Transport-Security "max-age=15552000; includeSubDomains; preload;" always; 49 | 50 | # set max upload size 51 | client_max_body_size 20G; 52 | fastcgi_buffers 64 4K; 53 | 54 | # Enable gzip but do not remove ETag headers 55 | gzip on; 56 | gzip_vary on; 57 | gzip_comp_level 4; 58 | gzip_min_length 256; 59 | gzip_proxied expired no-cache no-store private no_last_modified no_etag auth; 60 | 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; 61 | 62 | # Pagespeed is not supported by Nextcloud, so if your server is built 63 | # with the `ngx_pagespeed` module, uncomment this line to disable it. 64 | #pagespeed off; 65 | 66 | # The settings allows you to optimize the HTTP2 bandwidth. 67 | # See https://blog.cloudflare.com/delivering-http-2-upload-speed-improvements/ 68 | # for tuning hints 69 | client_body_buffer_size 512k; 70 | 71 | # HSTS settings 72 | # WARNING: Only add the preload option once you read about 73 | # the consequences in https://hstspreload.org/. This option 74 | # will add the domain to a hardcoded list that is shipped 75 | # in all major browsers and getting removed from this list 76 | # could take several months. 77 | #add_header Strict-Transport-Security "max-age=15768000; includeSubDomains; preload;" always; 78 | 79 | # HTTP response headers borrowed from Nextcloud `.htaccess` 80 | add_header Referrer-Policy "no-referrer" always; 81 | add_header X-Content-Type-Options "nosniff" always; 82 | add_header X-Download-Options "noopen" always; 83 | add_header X-Frame-Options "SAMEORIGIN" always; 84 | add_header X-Permitted-Cross-Domain-Policies "none" always; 85 | add_header X-Robots-Tag "noindex,nofollow" always; 86 | add_header X-XSS-Protection "1; mode=block" always; 87 | 88 | # Remove X-Powered-By, which is an information leak 89 | fastcgi_hide_header X-Powered-By; 90 | 91 | # Path to the root of your installation 92 | root /var/www/html; 93 | 94 | # Add .mjs as a file extension for javascript 95 | # Either include it in the default mime.types list 96 | # or include you can include that list explicitly and add the file extension 97 | # only for Nextcloud like below: 98 | include mime.types; 99 | types { 100 | application/javascript js mjs; 101 | } 102 | 103 | # Specify how to handle directories -- specifying `/index.php$request_uri` 104 | # here as the fallback means that Nginx always exhibits the desired behaviour 105 | # when a client requests a path that corresponds to a directory that exists 106 | # on the server. In particular, if that directory contains an index.php file, 107 | # that file is correctly served; if it doesn't, then the request is passed to 108 | # the front-end controller. This consistent behaviour means that we don't need 109 | # to specify custom rules for certain paths (e.g. images and other assets, 110 | # `/updater`, `/ocs-provider`), and thus 111 | # `try_files $uri $uri/ /index.php$request_uri` 112 | # always provides the desired behaviour. 113 | index index.php index.html /index.php$request_uri; 114 | 115 | # Rule borrowed from `.htaccess` to handle Microsoft DAV clients 116 | location = / { 117 | if ( $http_user_agent ~ ^DavClnt ) { 118 | return 302 /remote.php/webdav/$is_args$args; 119 | } 120 | } 121 | 122 | location = /robots.txt { 123 | allow all; 124 | log_not_found off; 125 | access_log off; 126 | } 127 | 128 | # Make a regex exception for `/.well-known` so that clients can still 129 | # access it despite the existence of the regex rule 130 | # `location ~ /(\.|autotest|...)` which would otherwise handle requests 131 | # for `/.well-known`. 132 | location ^~ /.well-known { 133 | # The rules in this block are an adaptation of the rules 134 | # in `.htaccess` that concern `/.well-known`. 135 | 136 | location = /.well-known/carddav { return 301 http://$host/remote.php/dav/; } 137 | location = /.well-known/caldav { return 301 http://$host/remote.php/dav/; } 138 | 139 | location /.well-known/acme-challenge { try_files $uri $uri/ =404; } 140 | location /.well-known/pki-validation { try_files $uri $uri/ =404; } 141 | 142 | # Let Nextcloud's API for `/.well-known` URIs handle all other 143 | # requests by passing them to the front-end controller. 144 | return 301 /index.php$request_uri; 145 | } 146 | 147 | # Rules borrowed from `.htaccess` to hide certain paths from clients 148 | location ~ ^/(?:build|tests|config|lib|3rdparty|templates|data)(?:$|/) { return 404; } 149 | location ~ ^/(?:\.|autotest|occ|issue|indie|db_|console) { return 404; } 150 | 151 | # Ensure this block, which passes PHP files to the PHP process, is above the blocks 152 | # which handle static assets (as seen below). If this block is not declared first, 153 | # then Nginx will encounter an infinite rewriting loop when it prepends `/index.php` 154 | # to the URI, resulting in a HTTP 500 error response. 155 | location ~ \.php(?:$|/) { 156 | # Required for legacy support 157 | rewrite ^/(?!index|remote|public|cron|core\/ajax\/update|status|ocs\/v[12]|updater\/.+|ocs-provider\/.+|.+\/richdocumentscode\/proxy) /index.php$request_uri; 158 | 159 | fastcgi_split_path_info ^(.+?\.php)(\/.*|)$; 160 | set $path_info $fastcgi_path_info; 161 | try_files $fastcgi_script_name =404; 162 | 163 | include fastcgi_params; 164 | fastcgi_param SCRIPT_FILENAME $document_root$fastcgi_script_name; 165 | fastcgi_param PATH_INFO $path_info; 166 | 167 | fastcgi_param modHeadersAvailable true; # Avoid sending the security headers twice 168 | fastcgi_param front_controller_active true; # Enable pretty urls 169 | fastcgi_pass php-handler; 170 | 171 | fastcgi_intercept_errors on; 172 | fastcgi_request_buffering off; 173 | 174 | fastcgi_max_temp_file_size 0; 175 | } 176 | 177 | # Serve static files 178 | location ~ \.(?:css|js|mjs|svg|gif|png|jpg|ico|wasm|tflite|map|ogg|flac)$ { 179 | try_files $uri /index.php$request_uri; 180 | add_header Cache-Control "public, max-age=15778463"; 181 | access_log off; # Optional: Don't log access to assets 182 | 183 | location ~ \.wasm$ { 184 | default_type application/wasm; 185 | } 186 | } 187 | 188 | location ~ \.woff2?$ { 189 | try_files $uri /index.php$request_uri; 190 | expires 7d; # Cache-Control policy borrowed from `.htaccess` 191 | access_log off; # Optional: Don't log access to assets 192 | } 193 | 194 | # Rule borrowed from `.htaccess` 195 | location /remote { 196 | return 301 /remote.php$request_uri; 197 | } 198 | 199 | location / { 200 | try_files $uri $uri/ /index.php$request_uri; 201 | } 202 | } 203 | } -------------------------------------------------------------------------------- /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 | --------------------------------------------------------------------------------