diff --git a/docs/developers/changing-credentials.md b/docs/developers/changing-credentials.md new file mode 100644 index 0000000..e5a4273 --- /dev/null +++ b/docs/developers/changing-credentials.md @@ -0,0 +1,28 @@ +--- +sidebar_position: 6 +--- + +# Changing credentials +For some reason, you need to change your credentials. + +We provide you this option on `Account` tab in horsygui + +To increase account security, we don't provide changing your nickname option and to change your credentials, you need to have valid login in config file + +## Changing email +In email field, type your new email address and press `Change e-mail` button. + +![Changing email](/img/developers/changing-credentials/email.png) + +You will receive an email with confirmation link. + +If you don't have access to your email or you have forgotten your password, you can't change your email. Also, if you don't have an account in config, you can't change your email. + +## Changing password +To change your password, type old and new password and press `Change password` button. + +![Changing password](/img/developers/changing-credentials/password.png) + +If old pass doesn't match with passowrd in config file, you will get an error. + +So, if you changed password on other device, you need to log out and log in again. diff --git a/docs/developers/editing-packages.md b/docs/developers/editing-packages.md new file mode 100644 index 0000000..da8df9d --- /dev/null +++ b/docs/developers/editing-packages.md @@ -0,0 +1,29 @@ +--- +sidebar_position: 7 +--- + +# Editing packages +Editing packages is available only from horsygui. + +So, open `Account` tab, you need to be logged in. + +Under `Manage your packages` you can see all your packages. + +Double click on package to edit it. + +![Editing packages](/img/developers/editing-packages/form.png) + +Let's change description. + +![Editing description](/img/developers/editing-packages/description.png) + +Press `Update` button. + +You will see success message. + +Now, all data (database and search) have been updated. + +![In search](/img/developers/editing-packages/search.png) +![Info](/img/developers/editing-packages/info.png) + +You can bring back old package data by changing it again. diff --git a/docs/developers/gui-uploading.md b/docs/developers/gui-uploading.md index eb6bf37..3df4224 100644 --- a/docs/developers/gui-uploading.md +++ b/docs/developers/gui-uploading.md @@ -3,14 +3,31 @@ sidebar_position: 5 --- # Uploading from GUI -Open horsygui +Let's upload `shakalizator` app. -Navigate to `upload` tab +## Logging in +So, you have an account. + +Now, you should log in. + +Navigate to `Account` tab. + +If you aren't logged in, you won't see your name in the top right corner. + +So, press the `Log in/Log out` button. + +You will see form + +![Login form](/img/developers/gui-uploading/login.jpg) + +Fill out the form and press `Log in`. + +## Uploading +Navigate to `Upload` tab Fill the form ## Explanaiton of parameters -Let's upload `shakalizator` app. Uploading looked like this: @@ -41,10 +58,3 @@ So, you can add it here! Seventh option is main executable command. If your file is .exe, you can just add executable file name. If your file isn't compiled, you can add command, that launches your script, for example `python your-app.py` of `node your-app.js` etc. Press upload button. - -If you don't have login in config, you will be asked to login. - -## Logging in -So, you have an account. - -//TODO diff --git a/docs/more/virustotal.md b/docs/more/virustotal.md index e69de29..de640a5 100644 --- a/docs/more/virustotal.md +++ b/docs/more/virustotal.md @@ -0,0 +1,39 @@ +--- +sidebar_position: 1 +--- + +# VirusTotal +Cool feature available only in horsy! + +To enable it, you need to have VirusTotal API key. + +## Getting API key +Go to [VirusTotal](https://www.virustotal.com/) and create an account. + +![VirusTotal sign up](/img/more/virustotal/signup_button.png) + +Create account and open this in menu: + +![API key tab](/img/more/virustotal/apikey_button.png) + +Copy your api key: + +![API key](/img/more/virustotal/apikey.png) + +It is 64-character long string from random numbers and letters, for example +`0f000f0000f00f000000f0000f0000f00f0000f0000f00f0f0000f0f000f00f0` + +## Adding key +Open terminal and type: +``` +horsy --vt +``` + +## Disabling +Open terminal and type: +``` +horsy --vt disable +``` + +## Functionality +// TODO in docs diff --git a/static/img/developers/changing-credentials/email.png b/static/img/developers/changing-credentials/email.png new file mode 100644 index 0000000..363ba5e Binary files /dev/null and b/static/img/developers/changing-credentials/email.png differ diff --git a/static/img/developers/changing-credentials/password.png b/static/img/developers/changing-credentials/password.png new file mode 100644 index 0000000..fa0449e Binary files /dev/null and b/static/img/developers/changing-credentials/password.png differ diff --git a/static/img/developers/editing-packages/description.png b/static/img/developers/editing-packages/description.png new file mode 100644 index 0000000..1acc96a Binary files /dev/null and b/static/img/developers/editing-packages/description.png differ diff --git a/static/img/developers/editing-packages/form.png b/static/img/developers/editing-packages/form.png new file mode 100644 index 0000000..cdba4a0 Binary files /dev/null and b/static/img/developers/editing-packages/form.png differ diff --git a/static/img/developers/editing-packages/info.png b/static/img/developers/editing-packages/info.png new file mode 100644 index 0000000..0fc41d4 Binary files /dev/null and b/static/img/developers/editing-packages/info.png differ diff --git a/static/img/developers/editing-packages/search.png b/static/img/developers/editing-packages/search.png new file mode 100644 index 0000000..e747f67 Binary files /dev/null and b/static/img/developers/editing-packages/search.png differ diff --git a/static/img/developers/gui-uploading/login.jpg b/static/img/developers/gui-uploading/login.jpg new file mode 100644 index 0000000..cf2d2d2 Binary files /dev/null and b/static/img/developers/gui-uploading/login.jpg differ diff --git a/static/img/more/virustotal/apikey.png b/static/img/more/virustotal/apikey.png new file mode 100644 index 0000000..d150d3b Binary files /dev/null and b/static/img/more/virustotal/apikey.png differ diff --git a/static/img/more/virustotal/apikey_button.png b/static/img/more/virustotal/apikey_button.png new file mode 100644 index 0000000..f803910 Binary files /dev/null and b/static/img/more/virustotal/apikey_button.png differ diff --git a/static/img/more/virustotal/signup_button.png b/static/img/more/virustotal/signup_button.png new file mode 100644 index 0000000..507b17f Binary files /dev/null and b/static/img/more/virustotal/signup_button.png differ