10 |
11 |
12 |
13 | Rlog is a minimalistic blog/portfolio starter project intended to be used for a personal blog.
14 | The project is built using only Rust, HTML and CSS as to remain as lightweight and performant as possible.
15 |
16 | ## Inspiration
17 |
18 | Rlog was inspired by [Bearblog](https://bearblog.dev/), a similar project written in Django. If you're looking
19 | for a blog that you can edit online, definitely use Bearblog.
20 |
21 | ## Usage
22 |
23 | If you wish to use rlog for your own blog, it is recommended to fork the project, as to not interfere with the
24 | project's development.
25 |
26 | Rlog is a self-hosted project, meaning that you will need to host it on your own server.
27 |
28 | ### Without Docker
29 |
30 | To build the project, you will need to have Rust installed on your machine.
31 |
32 | To run the project, run the following command:
33 |
34 | ```bash
35 | cargo run
36 | ```
37 |
38 | This will start a server on `localhost:8080`, which you can access in your browser.
39 |
40 | To build the project for production, run the following command:
41 |
42 | ```bash
43 | cargo build --release
44 | ```
45 |
46 | This will create an executable in the `target/release` directory, which you can run to start the server.
47 |
48 | ```bash
49 | ./target/release/rlog
50 | ```
51 |
52 | You will have to move the `rlog` executable to the root of the project, so it has access to the `posts`,
53 | `templates` and `static` directories.
54 |
55 | ### With Docker
56 |
57 | Rlog can also be run using Docker. The Dockerfile and docker-compose.yml files are already provided in
58 | the project. All that is needed to run the project is to build the Docker image and run the container,
59 | using the following command:
60 |
61 | ```bash
62 | docker-compose up -d
63 | ```
64 |
65 | This will start a container running the project on `localhost:8080`.
66 |
67 | ### Additional notes
68 |
69 | To host the project on a server, you will need to configure a reverse proxy to forward requests to the
70 | service running the project. I will not go into detail on how to do this, as it is out of the scope of this
71 | project. Creating, running and hosting a service is not unique to rlog.
72 |
73 | **NOTE: This project is completely free to use and modify, all I ask is that you leave the `made with rlog`
74 | footer in the project.**
75 |
76 | ## Features
77 |
78 | Currently, there are 4 distinct pages in the project:
79 | - Home
80 | - About page
81 | - Contact page
82 | - Blog page
83 |
84 | The blog page is the only dynamic page in the project, as it reads the blog posts from a `posts` directory
85 | and parses, formats and displays them on the page.
86 |
87 | ## Using the blog
88 |
89 | ### Pages
90 |
91 | Each of the pages in the project are stored in the `templates` directory. Each page is a directory containing
92 | a `content.md` file, a `[page].html` file and an `meta.toml` file.
93 |
94 | The only thing you need to edit to customize the page is the `content.md` file, which is going to be the actual
95 | markdown content shown on the page.
96 |
97 | You can also edit the browser title, meta description and navigation title in the `meta.toml` file.
98 |
99 | ### Posts
100 |
101 | The blog posts are written in markdown, while their metadata is stored in a TOML file. You will find an example
102 | of a blog post in the `posts` directory. The metadata file is used to store the title, slug and date of a blog post,
103 | while the markdown file has the actual content of the post.
104 |
105 | ### Images
106 |
107 | Images can be used in any of the markdown files. To use an image, you can use a URL of an image hosted online,
108 | but it is not recommended.
109 |
110 | The best way to use an image in a post or page is to store the image in the `static/assets` directory and reference
111 | it in the markdown file.
112 |
--------------------------------------------------------------------------------
/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 |
3 | ## Reporting a Vulnerability
4 |
5 | If you find a security vulnerability inside rlog,
6 | we ask you to ethically and privately disclose it.
7 |
8 | We take security very seriously and will patch the vulnerability as quick as possible.
9 |
10 | To disclose any vulnerability, please do so by contacting the project owner at: 72min@proton.me
11 |
--------------------------------------------------------------------------------
/docker-compose.yml:
--------------------------------------------------------------------------------
1 | version: "3.8"
2 |
3 | services:
4 | rlog:
5 | container_name: rlog
6 | build:
7 | context: .
8 | dockerfile: Dockerfile
9 | restart: always
10 | ports:
11 | - "8080:8080"
12 |
--------------------------------------------------------------------------------
/docs/splash.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/72mins/rlog/023e906a125c756af3a2b3adf5cac98d0b25eff6/docs/splash.png
--------------------------------------------------------------------------------
/posts/sample-post/post.md:
--------------------------------------------------------------------------------
1 | ## This is a sample post
2 |
3 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nullam nec purus
4 | nec nunc tincidunt ultricies. Nullam nec purus nec nunc tincidunt ultricies.
5 |
--------------------------------------------------------------------------------
/posts/sample-post/post.toml:
--------------------------------------------------------------------------------
1 | title = 'Hello, World!'
2 | description = 'This is a sample post.'
3 | file_name = 'sample-post'
4 | posted_at = '03/08/2024'
5 |
--------------------------------------------------------------------------------
/src/handlers/about_handler.rs:
--------------------------------------------------------------------------------
1 | use crate::utils::extract_content::extract_content;
2 | use crate::utils::extract_meta::extract_meta;
3 | use crate::utils::get_html::get_html;
4 | use actix_web::{get, web, HttpResponse, Responder};
5 |
6 | #[get("/about")]
7 | pub async fn about(templates: web::Data) -> impl Responder {
8 | let content = match extract_content("templates/about/content.md") {
9 | Ok(c) => c,
10 | Err(e) => {
11 | println!("{:?}", e);
12 |
13 | return HttpResponse::InternalServerError()
14 | .content_type("text/html")
15 | .body("
10 | {% endblock header %}
11 |
12 | {% block content %}
13 | {{ content | safe }}
14 | {% endblock content %}
15 |
--------------------------------------------------------------------------------
/templates/contact/content.md:
--------------------------------------------------------------------------------
1 | This is where you would put your contact information. It can be an email address, links to social media, etc..
2 |
--------------------------------------------------------------------------------
/templates/contact/meta.toml:
--------------------------------------------------------------------------------
1 | title = 'Contact'
2 | navtitle = 'contact'
3 | description = 'The contact page meta description'
4 |
--------------------------------------------------------------------------------
/templates/home/content.md:
--------------------------------------------------------------------------------
1 | Welcome to [rlog](https://github.com/72mins/rlog), a minimalistic blog/portfolio starter.
2 |
3 | The vision for this project is to provide a simple, fast, bloat-less and optimized starting point for a blog/portfolio website.
4 |
5 | Everything is open source and anyone can take/modify the code to their liking. This includes the design, the code, the content, etc..
6 |
7 | All of it is provided completely free of charge. All I ask is to leave the 'made with rlog' link in the footer. That's it.
8 |
9 | rlog is built with only Rust and HTML/CSS. This decision was made to keep the project as lightweight and performant as possible.
10 |
11 | This project was inspired by [bearblog](https://bearblog.dev/), a similar project written in Django. Credit where credit is due.
12 |
--------------------------------------------------------------------------------
/templates/home/home.html:
--------------------------------------------------------------------------------
1 | {% extends "base.html" %}
2 |
3 | {% block head %}
4 | {{ meta.title }}
5 |
6 | {% endblock head %}
7 |
8 | {% block header %}
9 |
8 |
9 |