nextcloud-desktop/README.md

Nextcloud Desktop Client

The 💻 Nextcloud Desktop Client is a tool to synchronize files from Nextcloud Server with your computer.

💙 🎉 Contributing

🛠️ How to compile the desktop client

🏗️ System requirements includes OpenSSL 1.1.x, QtKeychain, Qt 5.x.x and zlib.

📝 Step by step instructions

Clone the repo and create build directory

$ git clone https://github.com/nextcloud/desktop.git
$ cd desktop
$ mkdir build
$ cd build

Compile and install

For development reasons it is better to install the client on user space instead on the global system. For example you could use in the next instructions path-to-install-folder/ as ~/.local/ in a linux system. If you want to install system wide you could use /usr/local or /opt/nextcloud/.

Linux

$ cmake .. -DCMAKE_INSTALL_PREFIX=path-to-install-folder/ -DCMAKE_BUILD_TYPE=Debug -DNO_SHIBBOLETH=1 -DQTKEYCHAIN_LIBRARY=/path-to-qt5keychain-folder/lib64/libqt5keychain.so -DQTKEYCHAIN_INCLUDE_DIR=/path-to-qt5keychain-folder/include/qt5keychain/ -DOPENSSL_ROOT_DIR=/path-to-openssl-folder/ -DOPENSSL_INCLUDE_DIR=path-to-openssl-folder/include -DOPENSSL_LIBRARIES=path-to-openssl-folder/lib
$ make install

Windows

$ cmake -G "Visual Studio 15 2017 Win64" .. -DCMAKE_INSTALL_PREFIX=path-to-install-folder/ -DCMAKE_BUILD_TYPE=Debug -DNO_SHIBBOLETH=1 -DPng2Ico_EXECUTABLE=/path-to-install-png2ico/png2ico.exe  -DQTKEYCHAIN_LIBRARY=/path-to-qt5keychain-folder/lib/qt5keychain.lib -DQTKEYCHAIN_INCLUDE_DIR=/path-to-qt5keychain-folder/include/qt5keychain/ -DOPENSSL_ROOT_DIR=/path-to-openssl-folder/ -DOPENSSL_INCLUDE_DIR=path-to-openssl-folder/include -DOPENSSL_LIBRARIES=path-to-openssl-folder/lib
$ cmake --build . --config Debug --target install

Mac OS

$ cmake .. -DCMAKE_INSTALL_PREFIX=path-to-install-folder/ -DCMAKE_BUILD_TYPE=Debug -DNO_SHIBBOLETH=1 -DQTKEYCHAIN_LIBRARY=/path-to-qt5keychain-folder/lib/libqt5keychain.dylib -DQTKEYCHAIN_INCLUDE_DIR=/path-to-qt5keychain-folder/include/qt5keychain/ -DOPENSSL_ROOT_DIR=/path-to-openssl-folder/ -DOPENSSL_INCLUDE_DIR=path-to-openssl-folder/include -DOPENSSL_LIBRARIES=path-to-openssl-folder/lib
$ make install

More detailed instructions can be found at the Desktop Client Wiki.

📥 Where to find binaries to download

🔆 Daily builds

• Daily builds based on the latest master are available for Linux 🐧, Mac, and Windows in the desktop/daily folder of our download server. For more info: Wiki/Daily Builds.

🚀 Releases

• Refer to the download page https://nextcloud.com/install/#install-clients

💣 Reporting issues

• If you find any bugs or have any suggestion for improvement, please file an issue at https://github.com/nextcloud/client/issues. Do not contact the authors directly by mail, as this increases the chance of your report being lost. 💥

😃 🏆 Pull requests

• If you created a patch 😍, please submit a Pull Request.
• How to create a pull request? This guide will help you get started: Opening a pull request ❤️

📡 Contact us

If you want to contact us, e.g. before starting a more complex feature, for questions ❓ you can join us at #nextcloud-client.

✌️ Code of conduct

The Nextcloud community has core values that are shared between all members during conferences, hackweeks and on all interactions in online platforms including Github and Forums. If you contribute, participate or interact with this community, please respect our shared values. 😌

📝 Source code

The Nextcloud Desktop Client is developed in Git. Since Git makes it easy to fork and improve the source code and to adapt it to your need, many copies can be found on the Internet, in particular on GitHub. However, the authoritative repository maintained by the developers is located at https://github.com/nextcloud/desktop.

📜 License

This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 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 General Public License
for more details.