android-apps-mirrors/SimpleX-Chat
0
0
Fork 0
mirror of https://github.com/simplex-chat/simplex-chat.git synced 2025-06-28 12:19:54 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: CLI compilation (#1359)

Browse source 
* docs: CLI compilation

* update

* remove BETA

* amend CLI build steps
This commit is contained in:
Evgeny Poberezkin 2022-11-18 17:54:57 +00:00 • committed by GitHub
parent a4be68f4bd
commit 0ad74d9538
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 44 additions and 21 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/CLI.md
View file

@ -85,29 +85,37 @@ move <binary> %APPDATA%/local/bin/simplex-chat.exe
On Linux, you can build the chat executable using [docker build with custom output](https://docs.docker.com/engine/reference/commandline/build/#custom-build-outputs):
```shell
$ git clone git@github.com:simplex-chat/simplex-chat.git
$ cd simplex-chat
$ git checkout stable
$ DOCKER_BUILDKIT=1 docker build --output ~/.local/bin .
git clone git@github.com:simplex-chat/simplex-chat.git
cd simplex-chat
git checkout stable
DOCKER_BUILDKIT=1 docker build --output ~/.local/bin .
```
> **Please note:** If you encounter `` version `GLIBC_2.28' not found `` error, rebuild it with `haskell:8.10.4-stretch` base image (change it in your local [Dockerfile](Dockerfile)).
> **Please note:** If you encounter `` version `GLIBC_2.28' not found `` error, rebuild it with `haskell:8.10.7-stretch` base image (change it in your local [Dockerfile](Dockerfile)).
#### Using Haskell stack
#### In any OS
Install [Haskell stack](https://docs.haskellstack.org/en/stable/README/):
1. Install [Haskell GHCup](https://www.haskell.org/ghcup/), GHC 8.10.7 and cabal:
```shell
curl -sSL https://get.haskellstack.org/ | sh
curl --proto '=https' --tlsv1.2 -sSf https://get-ghcup.haskell.org | sh
```
and build the project:
2. Build the project:
```shell
$ git clone git@github.com:simplex-chat/simplex-chat.git
$ cd simplex-chat
$ git checkout stable
$ stack install
git clone git@github.com:simplex-chat/simplex-chat.git
cd simplex-chat
git checkout stable
# on Linux
apt-get update && apt-get install -y build-essential libgmp3-dev zlib1g-dev
cp scripts/cabal.project.local.linux cabal.project.local
# or on MacOS:
# brew install openssl@1.1
# cp scripts/cabal.project.local.mac cabal.project.local
# you may need to amend cabal.project.local to point to the actual openssl location
cabal update
cabal install
```
## Usage
@ -140,7 +148,7 @@ You can still talk to people using default or any other server - it only affects
Run `simplex-chat -h` to see all available options.
### Access messaging servers via Tor (BETA)
### Access messaging servers via Tor
Install Tor and run it as SOCKS5 proxy on port 9050, e.g. on Mac you can:

11
docs/CONTRIBUTING.md
View file

@ -5,12 +5,9 @@
Add `cabal.project.local` to project root with the location of OpenSSL headers and libraries and flag setting encryption mode:
```
ignore-project: False
package direct-sqlcipher
extra-include-dirs: /opt/homebrew/opt/openssl@3/include
extra-lib-dirs: /opt/homebrew/opt/openssl@3/lib
flags: +openssl
cp scripts/cabal.project.local.mac cabal.project.local
# or
# cp scripts/cabal.project.local.linux cabal.project.local
```
OpenSSL can be installed with `brew install openssl`
OpenSSL can be installed with `brew install openssl@1.1`

9
scripts/cabal.project.local.linux Normal file
View file

@ -0,0 +1,9 @@
ignore-project: False
# amend to point to the actual openssl location
package direct-sqlcipher
extra-include-dirs: /usr/local/opt/openssl@1.1/include
extra-lib-dirs: /usr/local/opt/openssl@1.1/lib
flags: +openssl
test-show-details: direct

9
scripts/cabal.project.local.mac Normal file
View file

@ -0,0 +1,9 @@
ignore-project: False
# amend to point to the actual openssl location
package direct-sqlcipher
extra-include-dirs: /opt/homebrew/opt/openssl@1.1/include
extra-lib-dirs: /opt/homebrew/opt/openssl@1.1/lib
flags: +openssl
test-show-details: direct