i2pd documentation
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

132 lines
3.6 KiB

2 years ago
# Qt Desktop GUI app build instructions
7 years ago
2 years ago
## Build Requirements
Qt 5
2 years ago
7 years ago
## Under Windows
### Without Qt Creator
All commands should be run under MSYS2 mingw32.
2 years ago
(obsolete instructions, please do a PR if you have working instrucitons)
```bash
pacman -S git make tar mingw-w64-i686-gcc mingw-w64-i686-boost mingw-w64-i686-libpng mingw-w64-i686-openssl mingw-w64-i686-zlib
pacman -S mingw-w64-i686-qt5-static
pacman -S openssl-devel mingw-w64-i686-miniupnpc
mkdir -p /c/dev/
cd /c/dev/
git clone https://github.com/PurpleI2P/i2pd.git
cd i2pd
git checkout openssl
export MINGW='mingw32'
export PATH=/$MINGW/bin:/usr/bin:/mingw32/qt5-static/bin
cd qt/i2pd_qt
qmake
make USE_UPNP=yes
```
#### Caveats
It is important to restrict PATH as described above. If you have Strawberry Perl and/or Mercurial installed, it will pick up gcc & openssl from the wrong places.
If you are an Arch Linux user, refrain from updating system with `pacman -Syu`. Always update runtime separately as described on the home page, otherwise you might end up with DLLs incompatibility problems.
7 years ago
## Under Debian/Ubuntu
7 years ago
### With Qt Creator
```bash
# Debian
sudo apt-get install build-essential g++ make libcrypto++-dev libssl-dev \
libboost-all-dev libminiupnpc-dev libwebsocketpp-dev libqt5gui5 \
libqt5widgets5 git zlib1g-dev qt5-qmake qtbase5-dev
# Ubuntu
2 years ago
sudo apt install qtcreator qt5-default build-essential g++ make libcrypto++-dev \
libssl-dev libboost-all-dev libminiupnpc-dev libwebsocketpp-dev libqt5gui5 git \
zlib1g-dev
5 years ago
mkdir git
cd git
2 years ago
git clone --recursive https://github.com/PurpleI2P/i2pd-qt.git
5 years ago
```
2 years ago
Then, open Qt Creator; open `git/i2pd-qt/i2pd_qt.pro`; set build make parameter
5 years ago
`-jNUMBER-OF-CPU-CORES`, e.g. `-j7`. Then, finally, press Make button.
7 years ago
### Without Qt Creator
2 years ago
```bash
# Debian
sudo apt-get install build-essential g++ make libcrypto++-dev libssl-dev \
libboost-all-dev libminiupnpc-dev libwebsocketpp-dev libqt5gui5 \
libqt5widgets5 git zlib1g-dev qt5-qmake qtbase5-dev
# Ubuntu
2 years ago
sudo apt-get install build-essential g++ make libcrypto++-dev libssl-dev \
libboost-all-dev libminiupnpc-dev libwebsocketpp-dev qt5-default \
libqt5gui5 git zlib1g-dev
mkdir git
cd git
2 years ago
git clone --recursive https://github.com/PurpleI2P/i2pd-qt.git
4 years ago
cd i2pd-qt
```
4 years ago
For release build,
`qmake`
For debug build,
`qmake i2pd_qt.pro "CONFIG += debug"`
And when `qmake` completed, run:
`make USE_UPNP=yes`
## Under Kali
### Without Qt Creator
2 years ago
```bash
2 years ago
sudo apt-get install build-essential g++ make libcrypto++-dev libssl-dev \
libboost-all-dev libminiupnpc-dev libwebsocketpp-dev qtbase5-dev \
libqt5gui5 git zlib1g-dev
mkdir git
cd git
2 years ago
git clone --recursive https://github.com/PurpleI2P/i2pd-qt.git
cd i2pd-qt
```
For release build,
`qmake`
For debug build,
`qmake i2pd_qt.pro "CONFIG += debug"`
And when `qmake` completed, run:
`make USE_UPNP=yes`
## Building a Flatpak package
2 years ago
```bash
sudo apt install flatpak flatpak-builder
flatpak --user remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak --user install flathub org.kde.Sdk/x86_64/5.14 # required SDK version might be higher, check the manifest at https://github.com/flathub/website.i2pd.i2pd/blob/master/website.i2pd.i2pd.json
git clone https://github.com/flathub/website.i2pd.i2pd && cd website.i2pd.i2pd
export FLATPAK_BUILDER_N_JOBS=4 # build process jobs count
flatpak-builder --user --install --force-clean i2pd_build_dir website.i2pd.i2pd.json
```
2 years ago
## More details
For more details on build procedures, see the GitHub actions at https://github.com/PurpleI2P/i2pd-qt/tree/master/.github/workflows .