itepechi/akkoma
1
0
Fork 0
Code Issues Pull requests Releases Activity

Change some wording in README

Browse source
This commit is contained in:
itepechi 2023-08-06 03:59:16 +09:00
parent 2edf5c9a16
commit c4b272fb86
1 changed files with 7 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
README.md
View file

@ -8,10 +8,10 @@ The main differences between this and the upstream repository are
- Automatically builds the Akkoma backend when building the Docker image, instead of requiring complex commands after pulling/building images - Automatically builds the Akkoma backend when building the Docker image, instead of requiring complex commands after pulling/building images
- Files/directories to mount are minified and completely separated from the repository files, allowing better control over file permissions - Files/directories to mount are minified and completely separated from the repository files, allowing better control over file permissions
- Has an actual Docker entry point, rather than a command that pretends to be an entry point - Has an actual Docker entry point, rather than a command that pretends to be an entry point
- Has out-of-the-box support for PGroonga, the fast and accurate full-text search extension for PostgreSQL - Includes out-of-the-box support for [PGroonga](https://pgroonga.github.io/), the fast and accurate full-text search extension for PostgreSQL
- Supports Podman quite well - Supports Podman quite well
## How to Setup (Podman Rootless) ## How to setup (Podman Rootless)
### 0. Requirements ### 0. Requirements
@ -82,8 +82,11 @@ podman exec -it akkoma-web \
--output /etc/akkoma/config.exs --output /etc/akkoma/config.exs
``` ```
You will be asked a few questions. Make sure the database password is not `[autogenerated]`. A few notes on setup
- Make sure your database hostname is set correctly (e.g. localhost)
- Make sure your database password is also set correctly (don't leave it auto-generated)
- You should set the IP to listen on to 0.0.0.0
### 5. Test your setup ### 5. Test your setup
```sh ```sh
@ -120,7 +123,7 @@ podman exec -it akkoma-web \
--admin --admin
``` ```
Open the printed link to set your password. Follow the printed link to set your password.
--- ---