A fork of https://github.com/crosspoint-reader/crosspoint-reader
1# Web Server Guide
2
3This guide explains how to connect your CrossPoint Reader to WiFi and use the built-in web server to upload files from your computer or phone.
4
5## Overview
6
7CrossPoint Reader includes a built-in web server that allows you to:
8
9- Upload files wirelessly from any device on the same WiFi network
10- Browse and manage files on your device's SD card
11- Create folders to organize your library
12- Delete files and folders
13
14## Prerequisites
15
16- Your CrossPoint Reader device
17- A WiFi network
18- A computer, phone, or tablet connected to the **same WiFi network**
19
20---
21
22## Step 1: Accessing the WiFi Screen
23
241. From the main menu or file browser, navigate to the **Settings** screen
252. Select the **WiFi** option
263. The device will automatically start scanning for available networks
27
28---
29
30## Step 2: Connecting to WiFi
31
32### Viewing Available Networks
33
34Once the scan completes, you'll see a list of available WiFi networks with the following indicators:
35
36- **Signal strength bars** (`||||`, `|||`, `||`, `|`) - Shows connection quality
37- **`*` symbol** - Indicates the network is password-protected (encrypted)
38- **`+` symbol** - Indicates you have previously saved credentials for this network
39
40<img src="./images/wifi/wifi_networks.jpeg" height="500">
41
42### Selecting a Network
43
441. Use the **Left/Right** (or **Volume Up/Down**) buttons to navigate through the network list
452. Press **Confirm** to select the highlighted network
46
47### Entering Password (for encrypted networks)
48
49If the network requires a password:
50
511. An on-screen keyboard will appear
522. Use the navigation buttons to select characters
533. Press **Confirm** to enter each character
544. When complete, select the **Done** option on the keyboard
55
56<img src="./images/wifi/wifi_password.jpeg" height="500">
57
58**Note:** If you've previously connected to this network, the saved password will be used automatically.
59
60### Connection Process
61
62The device will display "Connecting..." while establishing the connection. This typically takes 5-10 seconds.
63
64### Saving Credentials
65
66If this is a new network, you'll be prompted to save the password:
67
68- Select **Yes** to save credentials for automatic connection next time (NOTE: These are stored in plaintext on the device's SD card. Do not use this for sensitive networks.)
69- Select **No** to connect without saving
70
71---
72
73## Step 3: Connection Success
74
75Once connected, the screen will display:
76
77- **Network name** (SSID)
78- **IP Address** (e.g., `192.168.1.102`)
79- **Web server URL** (e.g., `http://192.168.1.102/`)
80
81<img src="./images/wifi/wifi_connected.jpeg" height="500">
82
83**Important:** Make note of the IP address - you'll need this to access the web interface from your computer or phone.
84
85---
86
87## Step 4: Accessing the Web Interface
88
89### From a Computer
90
911. Ensure your computer is connected to the **same WiFi network** as your CrossPoint Reader
922. Open any web browser (Chrome is recommended)
933. Type the IP address shown on your device into the browser's address bar
94 - Example: `http://192.168.1.102/`
954. Press Enter
96
97### From a Phone or Tablet
98
991. Ensure your phone/tablet is connected to the **same WiFi network** as your CrossPoint Reader
1002. Open your mobile browser (Safari, Chrome, etc.)
1013. Type the IP address into the address bar
102 - Example: `http://192.168.1.102/`
1034. Tap Go
104
105---
106
107## Step 5: Using the Web Interface
108
109### Home Page
110
111The home page displays:
112
113- Device status and version information
114- WiFi connection status
115- Current IP address
116- Available memory
117
118Navigation links:
119
120- **Home** - Returns to the status page
121- **File Manager** - Access file management features
122
123<img src="./images/wifi/webserver_homepage.png" width="600">
124
125### File Manager
126
127Click **File Manager** to access file management features.
128
129#### Browsing Files
130
131- The file manager displays all files and folders on your SD card
132- **Folders** are highlighted in yellow and indicated with a 📁 icon
133- **EPUB Files** are highlighted in green and indicated with a 📗 icon
134- **All Other Files** are not highlighted and indicated with a 📄 icon
135- Click on a folder name to navigate into it
136- Use the breadcrumb navigation at the top to go back to parent folders
137
138<img src="./images/wifi/webserver_files.png" width="600">
139
140#### Uploading Files
141
1421. Click the **📤 Upload** button in the top-right corner
1432. Click **Choose File** and select a file from your device
1443. Click **Upload**
1454. A progress bar will show the upload status
1465. The page will automatically refresh when the upload is complete
147
148<img src="./images/wifi/webserver_upload.png" width="600">
149
150#### Creating Folders
151
1521. Click the **📁 New Folder** button in the top-right corner
1532. Enter a folder name (must not contain characters \" * : < > ? / \\ | and must not be . or ..)
1543. Click **Create Folder**
155
156This is useful for organizing your library by genre, author, series or file type.
157
158#### Deleting Files and Folders
159
1601. Click the **🗑️** (trash) icon next to any file or folder
1612. Confirm the deletion in the popup dialog
1623. Click **Delete** to permanently remove the item
163
164**Warning:** Deletion is permanent and cannot be undone!
165
166**Note:** Folders must be empty before they can be deleted.
167
168#### Moving Files
169
1701. Click the **📂** (folder) icon next to any file
1712. Enter a folder name or select one from the dropdown
1723. Click **Move** to relocate the file
173
174**Note:** Typing in a nonexistent folder name will result in the following error: "Failed to move: Destination not found"
175
176#### Renaming Files
177
1781. Click the **✏️** (pencil) icon next to any file
1792. Enter a file name (must not contain characters \" * : < > ? / \\ | and must not be . or ..)
1803. Click **Rename** to permanently rename the file
181
182---
183
184## Command Line File Management
185
186For power users, you can manage files directly from your terminal using `curl` while the device is in File Upload mode. Detailed documentation can be found [here](./webserver-endpoints.md).
187
188## Security Notes
189
190- The web server runs on port 80 (standard HTTP)
191- **No authentication is required** - anyone on the same network can access the interface
192- The web server is only accessible while the WiFi screen shows "Connected"
193- The web server automatically stops when you exit the WiFi screen
194- For security, only use on trusted private networks
195
196---
197
198## Technical Details
199
200- **Supported WiFi:** 2.4GHz networks (802.11 b/g/n)
201- **Web Server Port:** 80 (HTTP)
202- **Maximum Upload Size:** Limited by available SD card space
203- **Browser Compatibility:** All modern browsers (Chrome, Firefox, Safari, Edge)
204
205---
206
207## Tips and Best Practices
208
2091. **Organize with folders** - Create folders before uploading to keep your library organized
2102. **Check signal strength** - Stronger signals (`|||` or `||||`) provide faster, more reliable uploads
2113. **Upload multiple files** - You can select and upload multiple files at once; the manager will queue them and refresh when the batch is finished
2124. **Use descriptive names** - Name your folders clearly (e.g., "SciFi", "Mystery", "Non-Fiction")
2135. **Keep credentials saved** - Save your WiFi password for quick reconnection in the future
2146. **Exit when done** - Press **Back** to exit the WiFi screen and save battery
215
216---
217
218## Exiting WiFi Mode
219
220When you're finished uploading files:
221
2221. Press the **Back** button on your CrossPoint Reader
2232. The web server will automatically stop
2243. WiFi will disconnect to conserve battery
2254. You'll return to the previous screen
226
227Your uploaded files will be immediately available in the file browser!
228
229---
230
231## Related Documentation
232
233- [User Guide](../USER_GUIDE.md) - General device operation
234- [Troubleshooting](./troubleshooting.md) - Troubleshooting
235- [README](../README.md) - Project overview and features