Skip to content

Commit

Permalink
Add git submodule instructions to BUILDING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mup committed Jun 28, 2024
1 parent d15e3f1 commit 4e6fa75
Showing 1 changed file with 23 additions and 12 deletions.
35 changes: 23 additions & 12 deletions doc/BUILDING.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,23 @@ own. If you prefer the auto-update feature, you can use the official [mail](http

* An up-to-date version of Git is installed
* Node.js (check package.json `engines` field for the version)
* Emscripten 3.1.59
* WASM2JS (Included in Emscripten)

#### Build steps:

1. Clone the repository: `git clone https://github.com/tutao/tutanota.git`
2. Switch into the repository directory: `cd tutanota`
3. Checkout the latest web release tag: `git checkout tutanota-release-xxx`
4. run `npm ci` to install dependencies.
5. Build packages: `npm run build-packages`
6. Build the web part: `node webapp prod`
7. Switch into the build directory: `cd build`
8. Run the local server. Either use `node server` or `python -m SimpleHTTPServer 9000`.
9. Open `localhost:9000` with your favorite browser (tested: Firefox, Chrome/Chromium, Safari).
4. Initialize liboqs and argon2 submodules: `git submodule init`
5. Synchronize submodules: `git submodule sync --recursive`
6. Update submodules: `git submodule update`
7. run `npm ci` to install dependencies.
8. Build packages: `npm run build-packages`
9. Build the web part: `node webapp prod`
10. Switch into the build directory: `cd build`
11. Run the local server. Either use `node server` or `python -m SimpleHTTPServer 9000`.
12. Open `localhost:9000` with your favorite browser (tested: Firefox, Chrome/Chromium, Safari).

## Building and running your own Tuta Mail Android app

Expand All @@ -38,15 +43,18 @@ You can add https://github.com/tutao/tutanota/releases.atom to your feed reader
1. Clone the repository: `git clone https://github.com/tutao/tutanota.git`
2. Switch into the Tutanota directory: `cd tutanota`
3. Checkout the latest android release tag: `git checkout tutanota-android-release-xxx`
4. Install dependencies: `npm ci`
5. Build packages: `npm run build-packages`
6. Create a keystore if you don't have
4. Initialize liboqs and argon2 submodules: `git submodule init`
5. Synchronize submodules: `git submodule sync --recursive`
6. Update submodules: `git submodule update`
7. Install dependencies: `npm ci`
8. Build packages: `npm run build-packages`
9. Create a keystore if you don't have
one: `keytool -genkey -noprompt -keystore MyKeystore.jks -alias tutaKey -keyalg RSA -keysize 2048 -validity 10000 -deststoretype pkcs12 -storepass CHANGEME -keypass CHANGEME -dname "CN=com.example"`
7.
10.

run `APK_SIGN_ALIAS="tutaKey" APK_SIGN_STORE='MyKeystore.jks' APK_SIGN_STORE_PASS="CHANGEME" APK_SIGN_KEY_PASS="CHANGEME" node android`

7. Install the app on your device: `adb install -r <path-to-apk>` (path as printed by the build script)
11. Install the app on your device: `adb install -r <path-to-apk>` (path as printed by the build script)

## Building and running your own Tuta Mail Desktop client

Expand All @@ -63,7 +71,10 @@ Keep in mind that your own build of Tuta Mail Desktop will not update automatica
1. Clone the repository: `git clone https://github.com/tutao/tutanota.git`.
2. Switch into the Tutanota directory: `cd tutanota`
3. Checkout the latest web release tag: `git checkout tutanota-release-xxx`
4. Run `npm ci` to install dependencies.
4. Initialize liboqs and argon2 submodules: `git submodule init`
5. Synchronize submodules: `git submodule sync --recursive`
6. Update submodules: `git submodule update`
7. Run `npm ci` to install dependencies.

### Build:

Expand Down

0 comments on commit 4e6fa75

Please sign in to comment.