A fork of https://github.com/crosspoint-reader/crosspoint-reader
Docs: Add instructions for file management via curl (#282)
Per a [reddit
thread](https://www.reddit.com/r/xteinkereader/comments/1q0fk9r/if_using_crosspoint_firmware_you_can_upload_using/),
the file manager can be accessed via curl.
Given file upload or deletion via curl may be useful for advanced users,
I've added instructions.
authored by
Luke Stein
and committed by
GitHub
d4ae108d
7240cd52
+37
+3
USER_GUIDE.md
+3
USER_GUIDE.md
···
56
56
57
57
See the [webserver docs](./docs/webserver.md) for more information on how to connect to the web server and upload files.
58
58
59
+
> [!TIP]
60
+
> Advanced users can also manage files programmatically or via the command line using `curl`. See the [webserver docs](./docs/webserver.md) for details.
61
+
59
62
### 3.5 Settings
60
63
61
64
The Settings screen allows you to configure the device's behavior. There are a few settings you can adjust:
+34
docs/webserver.md
+34
docs/webserver.md
···
170
170
171
171
---
172
172
173
+
## Command Line File Management
174
+
175
+
For power users, you can manage files directly from your terminal using `curl` while the device is in File Upload mode.
176
+
177
+
### Uploading a File
178
+
To upload a file to the root directory, use the following command:
179
+
```bash
180
+
curl -F "file=@book.epub" "http://crosspoint.local/upload?path=/"
181
+
```
182
+
183
+
* **`-F "file=@filename"`**: Points to the local file on your computer.
184
+
* **`path=/`**: The destination folder on the device SD card.
185
+
186
+
### Deleting a File
187
+
188
+
To delete a specific file, provide the full path on the SD card:
189
+
190
+
```bash
191
+
curl -F "path=/folder/file.epub" "http://crosspoint.local/delete"
192
+
```
193
+
194
+
### Advanced Flags
195
+
196
+
For more reliable transfers of large EPUB files, consider adding these flags:
197
+
198
+
* `-#`: Shows a simple progress bar.
199
+
* `--connect-timeout 30`: Limits how long curl waits to establish a connection (in seconds).
200
+
* `--max-time 300`: Sets a maximum duration for the entire transfer (5 minutes).
201
+
202
+
> [!NOTE]
203
+
> These examples use `crosspoint.local`. If your network does not support mDNS or the address does not resolve, replace it with the specific **IP Address** displayed on your device screen (e.g., `http://192.168.1.102/`).
204
+
205
+
---
206
+
173
207
## Troubleshooting
174
208
175
209
### Cannot See the Device on the Network