nitro/nitro-imager
1
0
Fork 0
mirror of https://github.com/billsonnn/nitro-imager synced 2024-11-26 09:20:52 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update readme

Browse Source
This commit is contained in:
Bill 2021-09-09 03:26:16 -04:00
parent 2961fc75d4
commit 3782b865dc
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
README.md
View File

@ -4,8 +4,6 @@ This tool serves as a server-side habbo-imager using the same avatar generator f
## Configuration ## Configuration
**Make sure you run ``npm i`` before first use.**
You must configure your urls in `config.json` You must configure your urls in `config.json`
Your figuredata, figuremap, effectmap, & HabboAvatarActions can safely point to a remote URL without worrying about performance. Your figuredata, figuremap, effectmap, & HabboAvatarActions can safely point to a remote URL without worrying about performance.
@ -14,6 +12,36 @@ You should set all download urls to local absolute paths on your system, this wi
You must also set an absolute path to a location where rendered figures can save to. This can be a private folder that is not accessible from the web. You must also set an absolute path to a location where rendered figures can save to. This can be a private folder that is not accessible from the web.
## Running the server
**Make sure you run ``npm i`` before first use.**
You must compile the server by running ``npm run build``
To start the server you must run ``npm start``
The server will run on the desired host & port as set in the config. You must setup a reverse proxy on your server to make the imager publicly accessible.
NGINX Example
server {
listen 80;
listen [::]:80;
listen 443;
listen [::]:443;
server_name habbo-imaging.website.com;
location / {
proxy_pass http://localhost:1338;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
## URL paramaters ## URL paramaters
Their are a few different options you may pass as URL parameters to generate figures with different actions. All parameters are optional. Their are a few different options you may pass as URL parameters to generate figures with different actions. All parameters are optional.