Skip to content

Commit f716483

Browse files
committed
docs: add README for setup and usage
1 parent 739c94b commit f716483

File tree

5 files changed

+76
-0
lines changed

5 files changed

+76
-0
lines changed

README.md

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
# Linkora Browser Extension
2+
3+
Browser extension that adds "Share from other app" functionality to web browsers. Integrates with your Linkora Sync-Server to save and sync web page links with metadata.
4+
5+
## Quick Start
6+
7+
### Prerequisites
8+
Ensure your Linkora Sync-Server is running and accessible.
9+
10+
### Installation
11+
The extension is not yet available on official web stores. Manual installation is required:
12+
13+
1. **Download**: Get the latest release from the [Linkora Browser Extension Releases](https://github.com/linkora/browser-extension/releases) page
14+
15+
2. **Extract**: Unzip the downloaded file to a dedicated folder
16+
17+
3. **Load Extension**:
18+
19+
**Chromium-based browsers** (Chrome, Brave, Edge):
20+
- Navigate to `chrome://extensions` (or `brave://extensions`, `edge://extensions`)
21+
- Enable "Developer mode"
22+
- Click "Load unpacked" and select the extracted folder
23+
24+
**Firefox**:
25+
- Go to `about:debugging#/runtime/this-firefox`
26+
- Click "Load Temporary Add-on..." and select `manifest.json` from the extracted folder
27+
- *Note*: Firefox requires reloading the extension after each browser restart
28+
29+
### Configuration
30+
After installation:
31+
32+
1. Click the Linkora icon in your browser toolbar
33+
2. Enter your Linkora Sync-Server URL (e.g., `https://YOUR_SERVER_IP:PORT`)
34+
3. Provide the `serverAuthToken` configured on your Sync-Server
35+
36+
### HTTPS Certificate Setup (Important)
37+
For HTTPS functionality, proper certificate configuration is required:
38+
39+
**Chromium-based Browsers**: Import the certificate (`.pem` file) generated by your Sync-Server into your browser's trusted root certification authorities.
40+
41+
**Firefox**: Go to `about:preferences#privacy` → "View Certificates" → "Servers" and add your server URL with port.
42+
43+
## Compatibility
44+
45+
### Server Requirements
46+
Requires a running Linkora Sync-Server instance. The server provides the UI components and handles synchronization logic.
47+
48+
*Future Update*: Direct communication with the Linkora desktop app will be supported in an upcoming release.
49+
50+
### Browser Support
51+
**Tested**: Firefox and Brave
52+
53+
**Known Issues**: Zen browser (Firefox-based) experiences crashes during extension loading.
54+
55+
## Features
56+
57+
**Web Content Capture**: Saves web page metadata (URL, title, image) with optional notes into chosen folders. Replicates the mobile app's "Share from other app" workflow for desktop browsers.
58+
59+
**Sync-Server Integration**: Connects to your self-hosted Linkora Sync-Server for synchronization across devices.
60+
61+
**Hybrid Architecture**: Server-rendered UI with client-side browser operations.
62+
63+
## Screenshots
64+
| | | | |
65+
|---|---|---|---|
66+
| ![](assets/1.png) | ![](assets/2.png) | ![](assets/3.png) | ![](assets/4.png) |
67+
68+
Clicking on the folder name (in the last image) will save the link into that folder.
69+
70+
## Support
71+
**Star the repo** if you find Linkora useful
72+
73+
[![ko-fi](https://ko-fi.com/img/githubbutton_sm.svg)](https://ko-fi.com/sakethpathike)
74+
75+
## License
76+
This extension is licensed under the MIT License.

assets/1.png

55.3 KB
Loading

assets/2.png

26.4 KB
Loading

assets/3.png

48.1 KB
Loading

assets/4.png

51.7 KB
Loading

0 commit comments

Comments
 (0)