Carbonio Files CE

Files-CE backend service for Zextras Carbonio

Dependencies 🔗

The following dependencies are required to run the service correctly but they are not installed by the package. They must be installed if Mandatory otherwise user discretion is advised.

Name	Mandatory/Optional
carbonio-proxy	Mandatory
carbonio-files-db	Mandatory
carbonio-user-management	Mandatory
carbonio-storages-ce	Mandatory
carbonio-preview-ce	Optional

How to install 🏁

Install carbonio-files-ce via apt:

sudo apt install carbonio-files-ce

or via yum:

sudo yum install carbonio-files-ce

After the installation you must run pending-setups in order to register the service in service-discover.

How to build ⚙

This is a Quarkus service; the deployable is the app module.

JVM build:

mvn clean install

Native build (Mandrel/GraalVM):

mvn clean install -Dnative

How to run 🚀

JVM mode:

java -Djava.net.preferIPv4Stack=true -jar app/target/quarkus-app/quarkus-run.jar

Native binary (app/target/*-runner, the artifact packaged and shipped):

./app/target/carbonio-files-ce-runner -Djava.net.preferIPv4Stack=true

Dev mode with live reload:

mvn -pl app quarkus:dev

Development 🛠

This repo uses the pre-commit framework (.pre-commit-config.yaml). Install it once per clone:

pip install --user pre-commit
pre-commit install --hook-type pre-commit --hook-type commit-msg

Besides linting/formatting, pre-commit locally regenerates the files CI previously generated and bot-committed (Jenkins now only verifies them):

• THIRDPARTIES — regenerated via a vendored copy of jenkins-lib-common's license-maven-plugin invocation/template (.ci/thirdparties/).
• package/PKGBUILD sha256sums — verified/autofixed via a vendored copy of jenkins-lib-common's checksum-verify.sh (.ci/checksum-verify.sh); SKIP entries (build artifacts, or sources whose content embeds pkgver) are always preserved.

If a hook regenerates a file, pre-commit will fail that commit (by design — it does not auto-stage changes for you). Review the diff, git add the regenerated file(s), and re-run git commit.

License 📚

Files-CE backend service for Zextras Carbonio.

Released under the AGPL-3.0-only license as specified here: COPYING.

Copyright (C) 2022 Zextras https://www.zextras.com

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program.  If not, see <https://www.gnu.org/licenses/>.

See COPYING file for the project license details

See THIRDPARTIES file for other licenses details

Copyright notice

All non-software material (such as, for example, names, images, logos, sounds) is owned by Zextras s.r.l. and is licensed under CC-BY-NC-SA.

Where not specified, all source files owned by Zextras s.r.l. are licensed under AGPL-3.0-only