diff --git a/README.md b/README.md index 45b983b..fcd3e35 100644 --- a/README.md +++ b/README.md @@ -1 +1,19 @@ -hi +# Imageify + +Your new open-source ShareX image host! + +## Setup + +- Download the git repo `git clone https://github.com/RealFascinated/imageify.git` + +- Cd into the new directory `cd imageify` +- Rename the example env `mv .env-example .env` +- Update the env file to your needs +- Start the server `docker compose up -d` +- Create an admin account\* +- Visit the website + +## How to create an admin account + +- Run `docker exec -it imageify-server npm run cli user add admin@example.com` +- You will get a password returned and you can now login to you admin account. (Please note that you should change this password)