Skip to content

Commit

Permalink
Update README: add the workflow badge
Browse files Browse the repository at this point in the history
Signed-off-by: JmPotato <[email protected]>
  • Loading branch information
JmPotato committed Aug 23, 2024
1 parent 62dd746 commit 31b1dab
Showing 1 changed file with 9 additions and 3 deletions.
12 changes: 9 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,10 @@

> 'r{}'.format(''.join(sorted('[Pomash](https://github.com/JmPotato/Pomash)'))[::-1]) == 'rsomhaP'
rsomhaP is a simple ready-to-use blog engine written in Rust.

[![Demo Deployment Status](https://github.com/JmPotato/rsomhaP/actions/workflows/fly-deploy.yml/badge.svg)](https://github.com/JmPotato/rsomhaP/actions/workflows/fly-deploy.yml)

## What is rsomhaP?

[Pomash](https://github.com/JmPotato/Pomash) is a blog engine written in Python, which was almost my first usable project created back in 2014. Although it hosted [my blog](https://ipotato.me) well for the past decade, since its code is somewhat messy and full of "young programmer" mistakes, I decided to rewrite it in Rust to make it more maintainable and as a commemorative project to its former self. Then here it is: rsomhaP.
Expand All @@ -16,11 +20,11 @@ But also introduces some new features:

- More secure admin authentication.
- Use any MySQL-compatible database to store your blog data.
- Easy to deploy with a simple [Dockerfile](./Dockerfile).
- Easy to deploy with a single command or a simple [Dockerfile](https://github.com/JmPotato/rsomhaP/blob/main/Dockerfile).

## Deployment

Edit your [`config.toml`](./config.toml) to your liking, then run:
Edit your [`config.toml`](https://github.com/JmPotato/rsomhaP/blob/main/config.toml) to your liking, then run:

```sh
cargo run --release
Expand All @@ -33,6 +37,8 @@ docker build -t rsomhap .
docker run -p 5299:5299 rsomhap
```

Access the admin page at http://{your-deployment-url}/admin to manage your blog. The initial password is the same as the username configured in [`config.toml`](https://github.com/JmPotato/rsomhaP/blob/62dd746dfd6f7413d161a1fde79b82a0589b241b/config.toml#L14), **which you should change after the first login as soon as possible.**.

Technically, you can deploy rsomhaP with modern SaaS infrastructures entirely free from scratch. For example:

- Use [TiDB Serverless](https://www.pingcap.com/tidb-serverless) as the MySQL-compatible database.
Expand All @@ -42,4 +48,4 @@ Technically, you can deploy rsomhaP with modern SaaS infrastructures entirely fr

## License

[MIT](./LICENSE)
[MIT](https://github.com/JmPotato/rsomhaP/blob/main/LICENSE)

0 comments on commit 31b1dab

Please sign in to comment.