Skip to content

Commit

Permalink
Cherry.md (#131)
Browse files Browse the repository at this point in the history
* Create Cherry Doc page.

* Add reference to index.md

* Add reference to mkdocs.yml

* Fix some minor "Prettier" MD formatting.
  • Loading branch information
RaneyDazed authored Oct 27, 2022
1 parent df389f1 commit 4223c0f
Show file tree
Hide file tree
Showing 3 changed files with 46 additions and 0 deletions.
44 changes: 44 additions & 0 deletions docs/sandbox/apps/cherry.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
# Cherry

## What is it?

[Cherry](https://cherry.haishan.me/){: target=_blank rel="noopener noreferrer" } is a bookmark service that is open source.

- The code of Cherry service and the browser extension are all available on GitHub.

- It's self-hostable. Your data in in your own hands. Using SQLite, management and backup is a breeze.

- It has a simple UI. But you got all the features you want for a bookmark service. Tags, groups, full text search and browser extensions.

!!!info
By default, the role is protected behind your Authelia/SSO middleware. You will also have to log into the app itself.

| Details | | |
|-------------|-------------|-------------|
| [:material-home: Project home](https://cherry.haishan.me/){: .header-icons target=_blank rel="noopener noreferrer" } | [:octicons-link-16: Docs](https://cherry.haishan.me/docs/intro){: .header-icons target=_blank rel="noopener noreferrer" } | [:octicons-mark-github-16: Github](https://github.com/haishanh/cherry){: .header-icons target=_blank rel="noopener noreferrer" } |

### 1. Installation

``` shell

sb install sandbox-cherry

```

### 2. URL

- To access Cherry, visit `https://cherry._yourdomain.com_`

### 3. Setup

- Default login:

``` { .yaml}
Username: "your user from accounts.yml"
Password: your_normal_password
```

!!!note
To create an additional user, use Cherry cli: `docker exec cherry cherry create-user <email> <password>`

- [:octicons-link-16: Documentation: Cherry Docs](https://cherry.haishan.me/docs/intro){: .header-icons target=_blank rel="noopener noreferrer" }
1 change: 1 addition & 0 deletions docs/sandbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@
- **[bookstack](../sandbox/apps/bookstack.md)** - tag - `sandbox-bookstack`
- **[calibre](../sandbox/apps/calibre.md)** - tag - `sandbox-calibre`
- **[calibre_web](../sandbox/apps/calibre_web.md)** - tag - `sandbox-calibre-web`
- **[cherry](../sandbox/apps/cherry.md)** - tag - `sandbox-cherry`
- **[coder](../sandbox/apps/coder.md)** - tag - `sandbox-coder`
- **[comicstreamer](../sandbox/apps/comicstreamer.md)** - tag - `sandbox-comicstreamer`
- **[comixed](../sandbox/apps/comixed.md)** - tag - `sandbox-comixed`
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -122,6 +122,7 @@ nav:
- ArrX: sandbox/apps/arrx.md
- General:
- AdGuard Home: sandbox/apps/adguardhome.md
- Cherry: sandbox/apps/cherry.md
- Joplin: sandbox/apps/joplin.md
- Linkding: sandbox/apps/linkding.md
- Nabarr: sandbox/apps/nabarr.md
Expand Down

0 comments on commit 4223c0f

Please sign in to comment.