About The Project

ActivityPub based blogengine

(back to top)

Getting Started

Installation

0. if you want useradd -m picverse passwd picverse
1. install go, nginx, certbot, postgres
2. git clone [project_link]
3. cp -r ../examples/config.json.example config/config.json then change dsn and host
4. mkdir /etc/nginx/sites-available & mkdir /etc/nginx/sites-enabled
5. sudo ufw allow 'Nginx HTTP
6. create database and user in postgres
7. go build picverse/cmd/main.go
8. ./main picverse table
9. git clone https://gitlab.com/kamee/picverse_template static
10. mkdir keys
11. openssl genrsa -out private.pem 2048
12. openssl rsa -in private.pem -outform PEM -pubout -out public.pem
13. vim /etc/nginx/sites-available/picverse.conf example:

upstream phoenix {
	server 127.0.0.1:8080 max_fails=5 fail_timeout=60s;
}
server {
	server_name example.rip www.example.rip;
	listen 80;
	listen [::]:80;
	location / {
		return 301 https://$server_name$request_uri;
	}
}
server {
	server_name example.rip www.example.rip;
 # [...certificate configs...]
	# the nginx default is 1m, not enough for large media uploads
	client_max_body_size 1m;
	ignore_invalid_headers off;
	proxy_http_version 1.1;
	proxy_set_header Upgrade $http_upgrade;
	proxy_set_header Connection "upgrade";
	proxy_set_header Host $http_host;
	proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
	location / {
		proxy_pass http://phoenix;
	}
	location ~ ^/(media|proxy) {
		slice 1m;
		proxy_cache_key $host$uri$is_args$args$slice_range;
		proxy_set_header Range $slice_range;
		proxy_cache_valid 200 206 301 304 1h;
		proxy_cache_lock on;
		proxy_ignore_client_abort on;
		proxy_buffering on;
		chunked_transfer_encoding on;
		proxy_pass http://phoenix;
	}
}

14. ./main -h to see available command to create new actor, new post, etc.

(back to top)

Usage

create a new actor:

./main -actor create

create a new post: touch first_post.md

./main -note create

create a post from images directory images in directory images/[some_dir/example.png

./main -note img

./main -note create

to see existing notes

./main -note load

TODO

(back to top)

Roadmap

TODO

• Docs
• Spam handling
• Testing/Benchmarks
• Multi-language Support
• Create a logo
• Improve perfomance of image loading
• C2S
• add .env - read db config from there

features

• Atom
• Sync with PubSub
• Sync with gemini capsule
• Convert posts to Gemini format
• Gallery mode

bugs

• fetching issues for unicode paths
• some follow requests were not added to db

(back to top)

Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

(back to top)

License

Distributed under the GNU License. See LICENSE.txt for more information.

(back to top)

Contact

fedi - @kamee@vostain.net mail - nokamee@protonmail.com

Project Links: codeberg

(back to top)

Acknowledgments

• go-fed/httpsig

(back to top)