Skip to content

Commit 390f4fe

Browse files
committed
Docs to use Google translate and doc update
1 parent fa53023 commit 390f4fe

39 files changed

+286
-2505
lines changed

.nojekyll

-1
Original file line numberDiff line numberDiff line change
@@ -1 +0,0 @@
1-

README.md

+19-9
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,39 @@
1+
12
# Getting Started
3+
24
![MobSF](https://cloud.githubusercontent.com/assets/4301109/20019521/cc61f7fc-a2f2-11e6-95f3-407030d9fdde.png)
3-
Mobile Security Framework (MobSF) is an automated, all-in-one mobile application (Android/iOS/Windows) pen-testing, malware analysis and security assessment framework capable of performing static and dynamic analysis.
5+
6+
Mobile Security Framework (MobSF) is an automated, all-in-one mobile application (Android/iOS/Windows) pen-testing, malware analysis, and security assessment framework capable of performing static and dynamic analysis.
7+
8+
---
49

510
### Project Developers
611

7-
[Ajin Abraham](https://in.linkedin.com/in/ajinabraham) ![india](https://user-images.githubusercontent.com/4301109/37564171-6549d678-2ab6-11e8-9b9d-21327c7f5d5b.png) | [Magaofei](https://github.com/magaofei) ![china](https://user-images.githubusercontent.com/4301109/44515364-00bbe880-a6e0-11e8-944d-5b48a86427da.png) | [Matan Dobrushin](https://github.com/matandobr) ![israel](https://user-images.githubusercontent.com/4301109/37564177-782f1758-2ab6-11e8-91e5-c76bde37b330.png) | [Vincent Nadal](https://github.com/superpoussin22) ![france](https://user-images.githubusercontent.com/4301109/37564175-71d6d92c-2ab6-11e8-89d7-d21f5aa0bda8.png)
12+
[Ajin Abraham](https://in.linkedin.com/in/ajinabraham) ![India](https://user-images.githubusercontent.com/4301109/37564171-6549d678-2ab6-11e8-9b9d-21327c7f5d5b.png) | [Magaofei](https://github.com/magaofei) ![China](https://user-images.githubusercontent.com/4301109/44515364-00bbe880-a6e0-11e8-944d-5b48a86427da.png) | [Matan Dobrushin](https://github.com/matandobr) ![Israel](https://user-images.githubusercontent.com/4301109/37564177-782f1758-2ab6-11e8-91e5-c76bde37b330.png) | [Vincent Nadal](https://github.com/superpoussin22) ![France](https://user-images.githubusercontent.com/4301109/37564175-71d6d92c-2ab6-11e8-89d7-d21f5aa0bda8.png)
813

14+
---
915

1016
### Support MobSF
1117

1218
[![Donate to MobSF](https://user-images.githubusercontent.com/4301109/117404264-7aab5480-aebe-11eb-9cbd-da82d7346bb3.png)](https://opensecurity.in/donate)
1319

14-
If you liked MobSF and find it useful, please consider donating.
20+
If you find MobSF useful, please consider donating to support its development.
1521

22+
---
1623

1724
### MobSF e-Learning Courses & Certification
1825

19-
We have 2 self paced e-learning courses that covers MobSF and other Android Security tools.
20-
21-
![MobSF Course](https://user-images.githubusercontent.com/4301109/76344880-ad68b580-62d8-11ea-8cde-9e3475fc92f6.png) [Automated Mobile Application Security Assessment with MobSF -MAS](https://opsecx.com/index.php/product/automated-mobile-application-security-assessment-with-mobsf/)
26+
We offer two self-paced e-learning courses that cover MobSF and other Android security tools:
2227

23-
![Android Security Tools Course](https://user-images.githubusercontent.com/4301109/76344939-c709fd00-62d8-11ea-8208-774f1d5a7c52.png) [Android Security Tools Expert -ATX](https://opsecx.com/index.php/product/android-security-tools-expert-atx/)
28+
- ![MobSF Course](https://user-images.githubusercontent.com/4301109/76344880-ad68b580-62d8-11ea-8cde-9e3475fc92f6.png) [Automated Mobile Application Security Assessment with MobSF - MAS](https://opsecx.com/index.php/product/automated-mobile-application-security-assessment-with-mobsf/)
29+
- ![Android Security Tools Course](https://user-images.githubusercontent.com/4301109/76344939-c709fd00-62d8-11ea-8208-774f1d5a7c52.png) [Android Security Tools Expert - ATX](https://opsecx.com/index.php/product/android-security-tools-expert-atx/)
2430

31+
---
2532

2633
### MobSF Support
2734

28-
* **Free Support:** Free limited support, questions, help and discussions, join our Slack channel [![Join_MobSF_Slack](https://img.shields.io/badge/mobsf%20slack-join-green?logo=slack&labelColor=4A154B)](https://join.slack.com/t/mobsf/shared_invite/zt-2huaz2nj9-ifViLV7g7w1xthx5D6rGhw)
29-
* **Enterprise Support:** Priority feature requests, live support & onsite training, see [![MobSF Support Packages](https://img.shields.io/badge/enterprise-support%20package-blue?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGMAAABaCAMAAACbkBjCAAAAAXNSR0IB2cksfwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAkNQTFRFAAAA////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////o1yoNQAAAMF0Uk5TAAQ1YH6IXzYFAUqq9P/1rU4CPdHWQ4X+jgOkro+hVWYR6vIajJvz+XN/z9sjLW6lrNPX+PsGHyE5TE9XWV1hW0k6LC7hs7SEhgr2sGRiFBCXJf38sgwOtmpoIiDf68vSGS+Z9yeR70RNvUEVfOa/WgdCR8XuUeeA8Du7Vporrx66SwlcqWV92g2HY+2Ki/GQJjxpM8TVcIGodjJ3ybETJOjUyiop4sxYkkVSGJ/pD6cdwlTOHNnIZ+B13bXkKL7NMOC0/xQAAAPPSURBVHic7dn5PxVRFADwY0sPN0t4Uj0vLQq9lkelRVFRKklZs+RRiiTtSbRoD9GuhdK+Ky3S9qf1Zu68bczcO5rjhz4f5yfnOud9mTszd+Y+gLH4f8PL28fXz893nP/4UQIMAYFBRIoJwSGho0CETSQeER6BLYRGGoksjFGTcIlouSDEZNRpmaJEEDIVkTApE4TEoBHmaWpG7HQsY4YaQchMJMI8S92IQ/pHZqsThMzBMeJZRgIKkcgiCJmLYcSwDQuGMY9tzMcwFrCNhQiEl5VtJCXrNxaxCUIW6zf8ecYS/UYKz1iq31jGM5brN1bwDB/9RirPQFhDuMdqpX5jFc9I0W+k8Yww/UY6z1it3zDzDLN+A9awiTUIBKxlGxkYRibbWIdhLGUbCLcrgPUTWETWegyDPSEbUAjYyDI24RjZWepE7GYcA3LUjSlIBGzJVSO2JmIZsG2UZ1wI1TUEYZ11RJ7KrFvz8Qy1S6QAkYBCZaMI0yhWNrZjGlCiRJSiElCmZJSPGWOGrtiheKFjGhW2yiVVO+XL+i6bz9pqHCB09x77B9YA1O6tcwHGffX7oYGQsnr9+2R5MeHiZx4QkmTTQSocsqUL+WHh5yNHs3UJxVHHpL87RBo5HphkbDwhvS770N9lNZ38Z6Gm2bXGmpyjLa7l1eI8cqdO/8tW7JmNHnutZ6XhtJzA1nOOx7bzbgUXLBdHKLRcKvU8iS4Lo2YL3de4cpXe1Ns8Sto7ro1A6AxMkl8KXQDXbc5tapLbuNsA0CSvumHy0gTkF96Ut9rjFtyWjRwFuDO8ruRuLVfoblLePLwH4bKRmwAFSpXW6E4WYC66rwjYw3fYY8MDgIMqxeWWh8qAobq1Uk0gJBJ6ej0GensAHqmWW1urDQoH6bE6YI82gD53pPeJvecpq+OZt5x4ztkJewEeSG+f0NTObIlL9SReDjtZZWEDd4QSoaqP2jRyX7kTr49wCPJGrKuqE5O34h0R3vGaYqvcjAxeNXlPC+k7biZNPnC7+l1EA7eYBNPKVjG5QxPuLgchH51GP79YetP/JCbxNDnOb5voIE7ya0kjvYboTSCInvsBGvocG5odGmrpkR2QsgF6vmvos0nGZw21X8TKCClrELOvGvq+UYK7SSwEnYIiKesSs0EtjXSl6dZSGi6WOr5ei3I7kTnRrd34LpYOSdmQmL1ANn6IpQlSRr+8mYpsiK9MyY672lbx4acZ2WgXKp84059C+gvZsAqVrt0ycWPsN7JhNHicrIPus6PBMJu0hPAcWOHM/giNKVr6zDAWI4i/nmw15nhs85kAAAAASUVORK5CYII=)](https://opensecurity.in/#support)
35+
- **Free Support**: For limited support, questions, and discussions, join our Slack channel.
36+
[![Join MobSF Slack](https://img.shields.io/badge/mobsf%20slack-join-green?logo=slack&labelColor=4A154B)](https://join.slack.com/t/mobsf/shared_invite/zt-2huaz2nj9-ifViLV7g7w1xthx5D6rGhw)
37+
38+
- **Enterprise Support**: For priority feature requests, live support, and onsite training, check our [Support Packages](https://opensecurity.in/#support).
39+
[![MobSF Support Packages](https://img.shields.io/badge/enterprise-support%20package-blue?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAGMAAABaCAMAAACbkBjCAAAAAXNSR0IB2cksfwAAAAlwSFlzAAALEwAACxMBAJqcGAAAAkNQTFRFAAAA////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////o1yoNQAAAMF0Uk5TAAQ1YH6IXzYFAUqq9P/1rU4CPdHWQ4X+jgOkro+hVWYR6vIajJvz+XN/z9sjLW6lrNPX+PsGHyE5TE9XWV1hW0k6LC7hs7SEhgr2sGRiFBCXJf38sgwOtmpoIiDf68vSGS+Z9yeR70RNvUEVfOa/WgdCR8XuUeeA8Du7Vporrx66SwlcqWV92g2HY+2Ki/GQJjxpM8TVcIGodjJ3ybETJOjUyiop4sxYkkVSGJ/pD6cdwlTOHNnIZ+B13bXkKL7NMOC0/xQAAAPPSURBVHic7dn5PxVRFADwY0sPN0t4Uj0vLQq9lkelRVFRKklZs+RRiiTtSbRoD9GuhdK+Ky3S9qf1Zu68bczcO5rjhz4f5yfnOud9mTszd+Y+gLH4f8PL28fXz893nP/4UQIMAYFBRIoJwSGho0CETSQeER6BLYRGGoksjFGTcIlouSDEZNRpmaJEEDIVkTApE4TEoBHmaWpG7HQsY4YaQchMJMI8S92IQ/pHZqsThMzBMeJZRgIKkcgiCJmLYcSwDQuGMY9tzMcwFrCNhQiEl5VtJCXrNxaxCUIW6zf8ecYS/UYKz1iq31jGM5brN1bwDB/9RirPQFhDuMdqpX5jFc9I0W+k8Yww/UY6z1it3zDzDLN+A9awiTUIBKxlGxkYRibbWIdhLGUbCLcrgPUTWETWegyDPSEbUAjYyDI24RjZWepE7GYcA3LUjSlIBGzJVSO2JmIZsG2UZ1wI1TUEYZ11RJ7KrFvz8Qy1S6QAkYBCZaMI0yhWNrZjGlCiRJSiElCmZJSPGWOGrtiheKFjGhW2yiVVO+XL+i6bz9pqHCB09x77B9YA1O6tcwHGffX7oYGQsnr9+2R5MeHiZx4QkmTTQSocsqUL+WHh5yNHs3UJxVHHpL87RBo5HphkbDwhvS770N9lNZ38Z6Gm2bXGmpyjLa7l1eI8cqdO/8tW7JmNHnutZ6XhtJzA1nOOx7bzbgUXLBdHKLRcKvU8iS4Lo2YL3de4cpXe1Ns8Sto7ro1A6AxMkl8KXQDXbc5tapLbuNsA0CSvumHy0gTkF96Ut9rjFtyWjRwFuDO8ruRuLVfoblLePLwH4bKRmwAFSpXW6E4WYC66rwjYw3fYY8MDgIMqxeWWh8qAobq1Uk0gJBJ6ej0GensAHqmWW1urDQoH6bE6YI82gD53pPeJvecpq+OZt5x4ztkJewEeSG+f0NTObIlL9SReDjtZZWEDd4QSoaqP2jRyX7kTr49wCPJGrKuqE5O34h0R3vGaYqvcjAxeNXlPC+k7biZNPnC7+l1EA7eYBNPKVjG5QxPuLgchH51GP79YetP/JCbxNDnOb5voIE7ya0kjvYboTSCInvsBGvocG5odGmrpkR2QsgF6vmvos0nGZw21X8TKCClrELOvGvq+UYK7SSwEnYIiKesSs0EtjXSl6dZSGi6WOr5ei3I7kTnRrd34LpYOSdmQmL1ANn6IpQlSRr+8mYpsiK9MyY672lbx4acZ2WgXKp84059C+gvZsAqVrt0ycWPsN7JhNHicrIPus6PBMJu0hPAcWOHM/giNKVr6zDAWI4i/nmw15nhs85kAAAAASUVORK5CYII=)](https://opensecurity.in/#support)

_navbar.md

+1-16
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,3 @@
11
<!-- _navbar.md -->
22
<!-- docs/_sidebar.md -->
3-
* Getting started
4-
* [Getting Started](/)
5-
* [Running MobSF](mobsf_docker.md)
6-
* [Dynamic Analyzer](dynamic_analyzer.md)
7-
8-
* Extras
9-
* [MobSF Docker Options](docker.md)
10-
* [Extras](extras.md)
11-
* [Develop](develop.md)
12-
* [SSO](sso.md)
13-
* [FAQ](faq.md)
14-
* Translations
15-
* [:uk: English](/)
16-
* [:cn: 中文](/zh-cn/)
17-
* [:jp: 日本語](/ja-jp/)
18-
* [:es: Español](/es/)
3+
* <div id="google_translate_element"></div>

_sidebar.md

+3-4
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
<!-- docs/_sidebar.md -->
2-
32
* [Getting Started](/)
4-
* [Running MobSF](mobsf_docker.md)
5-
* [Dynamic Analyzer](dynamic_analyzer.md)
6-
* [MobSF Docker Options](docker.md)
3+
* [Running MobSF](running_mobsf_docker.md)
4+
* [Dynamic Analyzer](dynamic_analyzer_docker.md)
5+
* [Docker Options](docker_options.md)
76
* [Extras](extras.md)
87
* [Develop](develop.md)
98
* [SSO](sso.md)

develop.md

+20-30
Original file line numberDiff line numberDiff line change
@@ -63,17 +63,14 @@ Operating Systems: Mac, Linux, Windows
6363
!> Please make sure that all the requirements mentioned are installed first.
6464

6565
```bash
66+
# Clone the MobSF repo
6667
git clone https://github.com/MobSF/Mobile-Security-Framework-MobSF.git
6768
cd Mobile-Security-Framework-MobSF
68-
```
6969
70-
## Linux/Mac
71-
```bash
70+
# Linux or Mac
7271
./setup.sh
73-
```
7472
75-
## Windows
76-
```batch
73+
# Windows
7774
setup.bat
7875
```
7976

@@ -83,14 +80,11 @@ setup.bat
8380

8481
# Running MobSF
8582

86-
## Linux/Mac
8783
```bash
84+
# Linux or Mac
8885
./run.sh 127.0.0.1:8000
89-
```
9086
91-
## Windows
92-
93-
```batch
87+
# Windows
9488
run.bat 127.0.0.1:8000
9589
```
9690

@@ -112,7 +106,7 @@ You need one of the following Android/iOS virtual device for Dynamic Analysis.
112106
!> Dynamic analysis using real mobile device is possible for Android, **but not supported by us.**
113107

114108
## Genymotion Android
115-
?> Supports x86, x86_64 architecture Android **4.1 - 11.0**, upto **API 30**
109+
?> Supports arm64, x86, x86_64 architecture Android **4.1 - 11.0**, upto **API 30**
116110

117111
Genymotion is the preferred dynamic analysis environment that you can setup with the least friction. Run a Genymotion Android VM **before starting MobSF.** Everything will be configured automatically at runtime. We recommend using **Android 7.0** and above.
118112

@@ -140,7 +134,9 @@ You can find the Android Device IP from the Genymotion title bar and the default
140134
141135
Install or upgrade your Android Studio to the latest. Android Emulator image with Google Play Store is considered as production image and you cannot use that with MobSF.
142136
143-
Create an Android Virtual Device (AVD) **without Google Play Store**.
137+
Create an Android Virtual Device (AVD) **without Google Play Store**.
138+
139+
!> You must not choose non-rooted **production** images. MobSF requires rooted images without Google Playstore pre-installed.
144140
145141
![Create AVD](https://github.com/user-attachments/assets/5871ff00-2386-4f32-be37-1d749825b069)
146142
@@ -153,7 +149,7 @@ Run an AVD **before starting MobSF** using `scripts/start_avd.sh` or `scripts/st
153149

154150
```bash
155151
# Run the script to list out available AVDs
156-
$ scripts/start_avd.sh
152+
scripts/start_avd.sh
157153
Available AVDs:
158154
159155
Medium_Phone_API_35
@@ -164,9 +160,10 @@ Use any Android AVD 5.0 - 11.0, up to API 30 without Google Play (production ima
164160
Usage: scripts/start_avd.sh AVD_NAME [START_PORT] [open_gapps.zip path]
165161
Example: scripts/start_avd.sh Pixel_6_Pro_API_28 5554 /path/to/open_gapps.zip
166162
167-
# Choose the AVD you created, make sure it is a non-production AVD. MobSF will not work with production AVDs.
163+
# Choose the AVD you created, make sure it is a non-production AVD.
164+
# MobSF will not work with production AVDs.
168165
169-
$ scripts/start_avd.sh Pixel_5_API_30
166+
sscripts/start_avd.sh Pixel_5_API_30
170167
```
171168

172169
Everything will be configured automatically at runtime. MobSF requires AVD version **5.0 to 11.0** for dynamic analysis.
@@ -178,11 +175,11 @@ Everything will be configured automatically at runtime. MobSF requires AVD versi
178175

179176
**GApps on AVD (Optional)**
180177

181-
If you need GApps, download the appropriate package from <https://opengapps.org/>.
178+
If you need Google Playstore, download the appropriate package from <https://opengapps.org/>.
182179
Run the `start_avd` script with path to the GApps zip file. This is currently not supported in Windows. You will have to manually do the necessary steps.
183180

184181
```bash
185-
$ scripts/start_avd.sh Pixel_6a_API_29 5554 ~/Downloads/open_gapps-arm64-10.0-stock-20220215.zip
182+
scripts/start_avd.sh Pixel_6a_API_29 5554 ~/Downloads/open_gapps-arm64-10.0-stock-20220215.zip
186183
```
187184

188185
If MobSF Dynamic Analyzer doesn't detect your android device, idenify the emulator serial number.
@@ -195,7 +192,7 @@ Example: `MOBSF_ANALYZER_IDENTIFIER='emulator-5554'`
195192
196193
197194
## Genymotion Cloud Android
198-
?> Supports x86, x86_64 architecture Android **5.1 - 11.0**, upto **API 30**
195+
?> Supports arm64, x86, x86_64 architecture Android **5.1 - 11.0**, upto **API 30**
199196
200197
Run a Genymotion Android VM in cloud and connect to it via adb **before starting MobSF.** Everything will be configured automatically at runtime. We recommend using **Android 7.0** and above.
201198
@@ -275,8 +272,6 @@ Supports jailbroken Corellium iOS VMs from MobSF v3.8.0 onwards.
275272

276273
# Updating MobSF
277274

278-
## Linux/Mac/Windows
279-
280275
```bash
281276
cd Mobile-Security-Framework-MobSF/
282277
git pull origin master
@@ -293,23 +288,18 @@ poetry run python mobsf/MobSF/tools_download.py %USERPROFILE%\.MobSF
293288
set DJANGO_SUPERUSER_PASSWORD=mobsf && poetry run python manage.py createsuperuser --noinput --username "mobsf" --email ""
294289
```
295290

296-
!> If database migration fails, you will have to delete (Linux or Mac: `~/.MobSF`, Windows: `C:\Users\<user>\.MobSF`) directory and run (Linux/Mac: `setup.sh`, Windows: `setup.bat`) again. This will delete previous scan results and data.
297-
291+
!> If database migration fails, delete the MobSF directory (`~/.MobSF` on Linux & Mac, `C:\Users\<user>\.MobSF` on Windows) and rerun the setup script (`setup.sh` for Linux & Mac or `setup.bat` for Windows). Note that this will remove all previous scan results and data.
298292
***
299293

300294
# Running Tests
301295

302296
We use tox for running tests.
303297
```bash
304298
pip install tox
305-
```
306299
307-
**For linting**
308-
```bash
300+
#For linting
309301
tox -e lint
310-
```
311302
312-
**For running lint + test**
313-
```bash
303+
# For running lint + test
314304
tox -e lint,test
315-
```
305+
```

docker.md

-67
This file was deleted.

0 commit comments

Comments
 (0)