Skip to content

Commit 99f6f47

Browse files
author
Oscar Henry Tejera
authored
Create README.md
1 parent 808da15 commit 99f6f47

File tree

1 file changed

+58
-0
lines changed

1 file changed

+58
-0
lines changed

README.md

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
# Overview #
2+
3+
This is a simple "REST" (I'm not so sure about that) service wrapper of [libimobiledevice](https://github.com/libimobiledevice/libimobiledevice) to communicate with services of Apple iOS devices using native
4+
protocols. This service works on Linux and macOS.
5+
6+
## Requirements
7+
8+
Install **libimobiledevice**:
9+
10+
**Linux (Ubuntu)**
11+
```bash
12+
13+
sudo add-apt-repository ppa:pmcenery/ppa
14+
sudo apt-get update
15+
sudo apt-get install libimobiledevice
16+
sudo apt-get install libimobiledevice-utils
17+
```
18+
19+
**macOS**
20+
```bash
21+
22+
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" < /dev/null 2> /dev/null
23+
brew install libimobiledevice
24+
```
25+
26+
## Configuration
27+
28+
We need to set the libimobiledevice binaries path. In order to know this path open a terminal and execute:
29+
30+
```bash
31+
32+
whereis ideviceinfo
33+
```
34+
35+
Copy the path on the **ios-service.config** file. E.G:
36+
37+
```ini
38+
service.port=5005
39+
libimobiledevice.path=/usr/bin/
40+
libimobiledevice.timeout=20000
41+
```
42+
43+
## Execution
44+
45+
* Download the latest version
46+
* Place the **ios-service.config** configuration file in the folder where **ios-service-X.X.X.jar** is located.
47+
* Start service:
48+
49+
```bash
50+
51+
sudo sudo service ios-service start
52+
```
53+
54+
* Send a GET request to http://ip:5005/api/v1/devices in order to verify that the service is running.
55+
56+
```bash
57+
curl http://127.0.0.1:5005/api/v1/devices
58+
```

0 commit comments

Comments
 (0)