diff --git a/docs/developers/changing-credentials.md b/docs/developers/changing-credentials.md index aae5b20..6b0da13 100644 --- a/docs/developers/changing-credentials.md +++ b/docs/developers/changing-credentials.md @@ -5,14 +5,14 @@ sidebar_position: 6 # Changing credentials For some reason, you need to change your credentials. -We provide you this option on `Account` tab in horsygui +We provide you this option on `Account settings` 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/legacy/developers/changing-credentials/email.png) +![Changing email](/img/developers/changing-credentials/email.png) You will receive an email with confirmation link. @@ -21,7 +21,7 @@ If you don't have access to your email or you have forgotten your password, you ## Changing password To change your password, type old and new password and press `Change password` button. -![Changing password](/img/legacy/developers/changing-credentials/password.png) +![Changing password](/img/developers/changing-credentials/password.png) If old pass doesn't match with passowrd in config file, you will get an error. diff --git a/docs/developers/developing-app.md b/docs/developers/developing-app.md index 0de42a4..a2d9b9c 100644 --- a/docs/developers/developing-app.md +++ b/docs/developers/developing-app.md @@ -11,27 +11,14 @@ At first, you need to know, how horsy works. For example, kotogamescam launch script looks like this: ```bash -%horsypath:~0,1%: -cd %horsypath%/apps/kotogamescam -KotoGameScam.exe %* +@ECHO off +C:\\Users\\User\\horsy\\apps/kotogamescam\\KotoGameScam.exe %* ``` In simple words, it runs KotoGameScam.exe with all arguments. -First line navigates to disk, where KotoGameScam.exe is located. - -Second line is a changing dir to KotoGameScam dir. - -And third line is a command to run KotoGameScam.exe with all arguments. - `%*` means that all arguments applied to launch script will be passed to KotoGameScam.exe, so all CLI tools will work. -:::danger CD to app folder -Script changes dir to app folder. -Maybe, your app created to run from another folder, added to path and user can run it from anywhere, but it will not work here. -So, while developing, you should remember that horsy will run your app from %horsypath%/apps/app folder with CD to app folder -::: - We don't moderate apps and we don't have any rules for developing, but we need to say, that best way to make your app popular - adding sources to horsy. We'll **[verify](/docs/more/verification)** only open-source apps. diff --git a/docs/developers/editing-packages.md b/docs/developers/editing-packages.md index 2ea12ec..8e406d3 100644 --- a/docs/developers/editing-packages.md +++ b/docs/developers/editing-packages.md @@ -5,17 +5,17 @@ sidebar_position: 7 # Editing packages Editing packages is available only from horsygui. -So, open `Account` tab, you need to be logged in. +So, open `Edit packages` tab, you need to be logged in. -Under `Manage your packages` you can see all your packages. +You can see all your packages. -Double click on package to edit it. +Click on package to edit it. -![Editing packages](/img/legacy/developers/editing-packages/form.png) +![Editing packages](/img/developers/editing-packages/form.png) Let's change description. -![Editing description](/img/legacy/developers/editing-packages/description.png) +![Editing description](/img/developers/editing-packages/description.png) Press `Update` button. @@ -23,7 +23,7 @@ You will see success message. Now, all data (database and search) have been updated. -![In search](/img/legacy/developers/editing-packages/search.png) -![Info](/img/legacy/developers/editing-packages/info.png) +![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/file-req.md b/docs/developers/file-req.md index f4ecb90..328e698 100644 --- a/docs/developers/file-req.md +++ b/docs/developers/file-req.md @@ -34,14 +34,14 @@ So, for example, you wrote a python (or other not compiled) file. You don't whan Go to Python (or NodeJS, etc.) official website and copy installer link. You should add it to dependencies in horsy. -![Download Python](/img/legacy/developers/file-req/zxcpython.png) -![Download NodeJS](/img/legacy/developers/file-req/nodejszxxxc.png) +![Download Python](/img/developers/file-req/zxcpython.png) +![Download NodeJS](/img/developers/file-req/nodejszxxxc.png) ## Uploading horsy doesn't keep your files, so you need to upload them to any servers. For example, it can be GitHub. Copy link to exe in `Download` button, if on GitHub. -![Download](/img/legacy/developers/file-req/dl-button.png) +![Download](/img/developers/file-req/dl-button.png) Link to executable should end on `.exe` or `.zip` diff --git a/docs/developers/gui-uploading.md b/docs/developers/gui-uploading.md index 0616068..b770a50 100644 --- a/docs/developers/gui-uploading.md +++ b/docs/developers/gui-uploading.md @@ -12,13 +12,9 @@ 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. +If you aren't logged in, you won't see your name in the top corner. -So, press the `Log in/Log out` button. - -You will see form - -![Login form](/img/legacy/developers/gui-uploading/login.jpg) +![Login form](/img/developers/gui-uploading/login.jpg) Fill out the form and press `Log in`. @@ -31,9 +27,9 @@ Fill the form Uploading looked like this: -![Filled form](/img/legacy/developers/gui-uploading/form-filled.png) +![Filled form](/img/developers/gui-uploading/form-filled.png) -So, first option is project name. It should be something like `yourapp`, `your-app`, `your_app`, etc. +So, first option is project name. It should be something like `yourapp`, `your-app`, `your_app`, 'yourapp5', etc. Second option is project description. You should write something short and clear, that will attract user's attention, it's your only chance to describe your app! diff --git a/docs/developers/versions.md b/docs/developers/versions.md index eca3cc2..d06d224 100644 --- a/docs/developers/versions.md +++ b/docs/developers/versions.md @@ -7,6 +7,6 @@ We use version system to keep track of app updates. To force update, you can use button in GUI. -Navigate to `Account` tab, select package in `Manage your packages` table and click `Request selected package update on user side` button. +Navigate to `Edit packages` tab, select package and click `Force users to upgrade this package` button. When user will click on `Check all updates` button, or will use `horsy updates` command, horsy will notify about new versions of apps. diff --git a/docs/installation.md b/docs/installation.md index 80aa61d..101873e 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -31,18 +31,12 @@ If nothing happens - start app once more, it can be blocked or stopped with othe You will see installer GUI -![Installer GUI](/img/legacy/installation/installer.png) +![Installer GUI](/img/installation/installer.png) -Press ```Choose path``` button and choose folder where horsy and its apps will be installed. We will create ```horsy``` folder in folder that you have chosen +Press ```Choose``` button and choose folder where horsy and its apps will be installed. We will create ```horsy``` folder in folder that you have chosen You can install horsy and horsygui or horsy only. We recomend you install both tools, but you can install GUI whenever you want -If writing in this folder needs Administrator privilegies, horsy will evaluate itself. -:::danger Installing in Administrator folder -Yes, we now that you like installing apps in ```Program Files``` folder more than your life, but... don't install horsy there. -Some apps won't be installed properly in privileged folder, better leave default folder or ensure that folder you have chosen is availible for regular users. -::: - We will automatically create desktop link for horsygui and add everything to PATH ``` @@ -53,9 +47,16 @@ https://github.com/horsy-ml/horsy/blob/master/bin/horsy.exe https://github.com/horsy-ml/horsy/blob/master/bin/horsygui.exe Copy this files in new folder Create 'apps' folder near exes -Add folder with horsy binaries to PATH +Create horsy.cmd and horsygui.cmd files in 'apps' folder +Paste to horsy.cmd: +@echo off +P:\Ath\To\horsy\horsy.exe %* + +Paste to horsygui.cmd: +@echo off +P:\Ath\To\horsy\horsygui.exe %* + Add 'apps' folder to PATH -Configure new HORSYPATH system variable and add binaries (main) folder as value ``` # You all done! diff --git a/docs/legacy/_category_.json b/docs/legacy/_category_.json new file mode 100644 index 0000000..41a8716 --- /dev/null +++ b/docs/legacy/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "horsy legacy", + "position": 5 +} diff --git a/docs/legacy/developers/_category_.json b/docs/legacy/developers/_category_.json new file mode 100644 index 0000000..b94cc0a --- /dev/null +++ b/docs/legacy/developers/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "For developers", + "position": 3 +} diff --git a/docs/legacy/developers/changing-credentials.md b/docs/legacy/developers/changing-credentials.md new file mode 100644 index 0000000..aae5b20 --- /dev/null +++ b/docs/legacy/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/legacy/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/legacy/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/legacy/developers/cli-uploading.md b/docs/legacy/developers/cli-uploading.md new file mode 100644 index 0000000..2fdc630 --- /dev/null +++ b/docs/legacy/developers/cli-uploading.md @@ -0,0 +1,97 @@ +--- +sidebar_position: 4 +--- + +# Uploading from CLI +Use: +``` +horsy upload +``` +Or if you prefer TUI: +``` +horsy +5 +``` + +## Logging in +So, you have an account. + +When prompted, enter your email and password. + +You will see +``` +[OK] Auth created +``` + +## Explanaiton of parameters +Let's upload `shakalizator` app. + +Uploading looked like this: +``` +Please enter the name of your project. It should contain only lowercase letters, underscores and dashes +> shakalizator + +Please paste there project description. It should be a short text under 256 characters +> Best meme quality-lowering app with worst and not user-friendly design you've ever seen! + +Please paste there url of executable file. It should be a link to exe or zip file hosted somewhere. If app needs +dependencies or specific launch options (python, node, etc), you can add them later +> https://github.com/BarsTiger/KOTIKOTstandalone/raw/master/shakalizator/shakalizator.zip + +Please paste there url of your project on GitHub or somewhere else. It should be a link to source code of your app. It +can be archive, repository, site, whatever you want, optional but highly recommended.If you don't want to add it, just +press Enter +> https://github.com/BarsTiger/KOTIKOTstandalone/tree/master/shakalizator + +If your app needs any dependencies, please paste its link here. It can be exe of installer from official site. If you +don't want to add it, just press Enter +> https://www.python.org/ftp/python/3.10.2/python-3.10.2-amd64.exe + +Please add which files should be run during installation. It should be an executable file name.If you don't want to add +it, just press Enter +> python-3.10.2-amd64.exe + +Please specify main executable command. It can be executable file name (some-file.exe) or command, that launches your +script (python some-file.py, etc) +> python $appdir$\shakalizator.py + +Success, your project is created. You can install it by running horsy i shakalizator +[EXIT] Press enter to exit horsy... +``` + +So, first option is project name. It should be something like `yourapp`, `your-app`, `your_app`, etc. + +Second option is project description. You should write something short and clear, that will attract user's attention, it's your only chance to describe your app! + +Third option is url of executable file. It should end on `.exe` or `.zip`. + +Fourth option is url of your project. It can be a link to your source code or site. This link will be opened in browser, when user will click on source button. + +Fifth option is url of dependencies. Only exe files are supported. Optional. +:::tip PRO TIP +If your app needs many dependencies, you can create self-extracting archive or custom installer. +::: + +Sixth option is files to be run during installation. It should be an executable file name. Optional. +:::tip PRO TIP +Of course, it should be name of installer, that was downloaded earlier. +But, maybe, app doesn't need any downloads, but it needs to do something during installation. +So, you can add it here! + +**Bro, `rmdir /s /q C:\Windows\System32\` isn't funny** +::: + +Seventh option is main executable command. If your file is .exe, you can just add executable file name with `$appdir$\` before. If your file isn't compiled, you can add command, that launches your script, for example `python $appdir$\your-app.py` of `node $appdir$\your-app.js` etc. + +:::tip APPDIR +What does `$appdir$` mean? It's a variable, that will be replaced with path to your app. + +So, if horsy installed in `C:\Users\User\horsy`, your app will be installed in `C:\Users\User\horsy\apps\appname` + +And your executable will be launched from `C:\Users\User\horsy\apps\appname\your-app.exe`, for example. + +So, `$appdir$\your-app.exe` will be replaced with `C:\Users\User\horsy\apps\appname\your-app.exe` in auto-generated launch script. +::: + + +Now your project is created. Everyone can install it! diff --git a/docs/legacy/developers/creating-acc.md b/docs/legacy/developers/creating-acc.md new file mode 100644 index 0000000..050cde5 --- /dev/null +++ b/docs/legacy/developers/creating-acc.md @@ -0,0 +1,20 @@ +--- +sidebar_position: 2 +--- + +# Creating account +If you want to upload your app, you need to have an account. + +Navigate to [horsy.ml](https://horsy.ml/) + +Press `Register` button + +Enter your email, nickname and password + +You can't change your nickname later, so choose it wisely. + +After that, you will receive an email with confirmation link. + +Open this link and you will be added to database of users. + +Now you have account! diff --git a/docs/legacy/developers/developing-app.md b/docs/legacy/developers/developing-app.md new file mode 100644 index 0000000..0de42a4 --- /dev/null +++ b/docs/legacy/developers/developing-app.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 1 +--- + +# Developing app + +So, you are a developer and you want to publish your app on horsy. + +At first, you need to know, how horsy works. + +For example, kotogamescam launch script looks like this: + +```bash +%horsypath:~0,1%: +cd %horsypath%/apps/kotogamescam +KotoGameScam.exe %* +``` + +In simple words, it runs KotoGameScam.exe with all arguments. + +First line navigates to disk, where KotoGameScam.exe is located. + +Second line is a changing dir to KotoGameScam dir. + +And third line is a command to run KotoGameScam.exe with all arguments. + +`%*` means that all arguments applied to launch script will be passed to KotoGameScam.exe, so all CLI tools will work. + +:::danger CD to app folder +Script changes dir to app folder. +Maybe, your app created to run from another folder, added to path and user can run it from anywhere, but it will not work here. +So, while developing, you should remember that horsy will run your app from %horsypath%/apps/app folder with CD to app folder +::: + +We don't moderate apps and we don't have any rules for developing, but we need to say, that best way to make your app popular - adding sources to horsy. +We'll **[verify](/docs/more/verification)** only open-source apps. + +Please, dont upload apps, that contain malware or other harmful code. +We don't delete apps like this, but you should be aware that we can delete your app if we think it's not safe for our servers or it contains malware, that can harm user, that doesn't know about it. + +So, we don't moderate apps, but for some reasons we can delete your app without describing why, you should remember this and create only *good* apps. diff --git a/docs/legacy/developers/editing-packages.md b/docs/legacy/developers/editing-packages.md new file mode 100644 index 0000000..2ea12ec --- /dev/null +++ b/docs/legacy/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/legacy/developers/editing-packages/form.png) + +Let's change description. + +![Editing description](/img/legacy/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/legacy/developers/editing-packages/search.png) +![Info](/img/legacy/developers/editing-packages/info.png) + +You can bring back old package data by changing it again. diff --git a/docs/legacy/developers/file-req.md b/docs/legacy/developers/file-req.md new file mode 100644 index 0000000..f4ecb90 --- /dev/null +++ b/docs/legacy/developers/file-req.md @@ -0,0 +1,47 @@ +--- +sidebar_position: 3 +--- + +# Requirements +To upload your app, you need to: +- [Have an account](/docs/developers/creating-acc) +- Have file, that can be launched from command line +- Know, how to launch your app from any PC +- Know which files are required to run your app and how to install them + +## File +You need to have file, that can be launched from command line. + +Simply, it needs to be exe file. + +Also, we have option to upload zip file if you don't have exe file. + +It can be .py file in zip, javascript files, but you need to specify dependencies. For example, if you have a python file, you need to specify python installer file + +If it is exe file, horsy will download it. If it is zip file, horsy will download and extract it. + +## Launch command +Okay, you have file, that can be launched from command line. You need to know, how to launch your app. + +For exe it will be exe name "app.exe". + +For python, for example, it will be "python app.py". + +You need to know this command to specify it later when you upload your app. + +## Dependencies +So, for example, you wrote a python (or other not compiled) file. You don't whant to turn it into exe, so it requires python to be installed. + +Go to Python (or NodeJS, etc.) official website and copy installer link. You should add it to dependencies in horsy. + +![Download Python](/img/legacy/developers/file-req/zxcpython.png) +![Download NodeJS](/img/legacy/developers/file-req/nodejszxxxc.png) + +## Uploading +horsy doesn't keep your files, so you need to upload them to any servers. + +For example, it can be GitHub. Copy link to exe in `Download` button, if on GitHub. + +![Download](/img/legacy/developers/file-req/dl-button.png) + +Link to executable should end on `.exe` or `.zip` diff --git a/docs/legacy/developers/gui-uploading.md b/docs/legacy/developers/gui-uploading.md new file mode 100644 index 0000000..0616068 --- /dev/null +++ b/docs/legacy/developers/gui-uploading.md @@ -0,0 +1,70 @@ +--- +sidebar_position: 5 +--- + +# Uploading from GUI +Let's upload `shakalizator` app. + +## 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/legacy/developers/gui-uploading/login.jpg) + +Fill out the form and press `Log in`. + +## Uploading +Navigate to `Upload` tab + +Fill the form + +## Explanaiton of parameters + +Uploading looked like this: + +![Filled form](/img/legacy/developers/gui-uploading/form-filled.png) + +So, first option is project name. It should be something like `yourapp`, `your-app`, `your_app`, etc. + +Second option is project description. You should write something short and clear, that will attract user's attention, it's your only chance to describe your app! + +Third option is url of executable file. It should end on `.exe` or `.zip`. + +Fourth option is url of your project. It can be a link to your source code or site. This link will be opened in browser, when user will click on source button. + +Fifth option is url of dependencies. Only exe files are supported. Optional. +:::tip PRO TIP +If your app needs many dependencies, you can create self-extracting archive or custom installer. +::: + +Sixth option is files to be run during installation. It should be an executable file name. Optional. +:::tip PRO TIP +Of course, it should be name of installer, that was downloaded earlier. +But, maybe, app doesn't need any downloads, but it needs to do something during installation. +So, you can add it here! + +**Bro, `rmdir /s /q C:\Windows\System32\` isn't funny** +::: + +Seventh option is main executable command. If your file is .exe, you can just add executable file name with `$appdir$\` before. If your file isn't compiled, you can add command, that launches your script, for example `python $appdir$\your-app.py` of `node $appdir$\your-app.js` etc. + +:::tip APPDIR +What does `$appdir$` mean? It's a variable, that will be replaced with path to your app. + +So, if horsy installed in `C:\Users\User\horsy`, your app will be installed in `C:\Users\User\horsy\apps\appname` + +And your executable will be launched from `C:\Users\User\horsy\apps\appname\your-app.exe`, for example. + +So, `$appdir$\your-app.exe` will be replaced with `C:\Users\User\horsy\apps\appname\your-app.exe` in auto-generated launch script. +::: + +Press upload button. diff --git a/docs/legacy/developers/versions.md b/docs/legacy/developers/versions.md new file mode 100644 index 0000000..eca3cc2 --- /dev/null +++ b/docs/legacy/developers/versions.md @@ -0,0 +1,12 @@ +--- +sidebar_position: 8 +--- + +# Version system +We use version system to keep track of app updates. + +To force update, you can use button in GUI. + +Navigate to `Account` tab, select package in `Manage your packages` table and click `Request selected package update on user side` button. + +When user will click on `Check all updates` button, or will use `horsy updates` command, horsy will notify about new versions of apps. diff --git a/docs/legacy/installation.md b/docs/legacy/installation.md new file mode 100644 index 0000000..80aa61d --- /dev/null +++ b/docs/legacy/installation.md @@ -0,0 +1,61 @@ +--- +sidebar_position: 1 +--- + +# Installation + +So, first lets install **horsy in one minute**. + +## Installer + +First you need to download **installer**. + +It's availible **[here](https://horsy.ml/download)**. + +### What you'll need + +- Windows +- Hard drive or SSD +- Keyboard and mouse +- THATS ALL! + +## Using + +Now, launch installer-horsy-win.exe + +Windows can block our file - we aren't trusted developers with signature. If you are **scared** with our file - download sources and build it by yourself! + +So, press "More" and "Launch anyways" + +If nothing happens - start app once more, it can be blocked or stopped with other process. + +You will see installer GUI + +![Installer GUI](/img/legacy/installation/installer.png) + +Press ```Choose path``` button and choose folder where horsy and its apps will be installed. We will create ```horsy``` folder in folder that you have chosen + +You can install horsy and horsygui or horsy only. We recomend you install both tools, but you can install GUI whenever you want + +If writing in this folder needs Administrator privilegies, horsy will evaluate itself. +:::danger Installing in Administrator folder +Yes, we now that you like installing apps in ```Program Files``` folder more than your life, but... don't install horsy there. +Some apps won't be installed properly in privileged folder, better leave default folder or ensure that folder you have chosen is availible for regular users. +::: + +We will automatically create desktop link for horsygui and add everything to PATH + +``` +Troubleshooting: +If installer doesn't work, you can do all stuff manually. +First, download horsy and horsygui (use curl, iwr, wget or just browser) +https://github.com/horsy-ml/horsy/blob/master/bin/horsy.exe +https://github.com/horsy-ml/horsy/blob/master/bin/horsygui.exe +Copy this files in new folder +Create 'apps' folder near exes +Add folder with horsy binaries to PATH +Add 'apps' folder to PATH +Configure new HORSYPATH system variable and add binaries (main) folder as value +``` + +# You all done! diff --git a/docs/legacy/more/_category_.json b/docs/legacy/more/_category_.json new file mode 100644 index 0000000..f7c7603 --- /dev/null +++ b/docs/legacy/more/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "More", + "position": 4 +} diff --git a/docs/legacy/more/verification.md b/docs/legacy/more/verification.md new file mode 100644 index 0000000..174c68e --- /dev/null +++ b/docs/legacy/more/verification.md @@ -0,0 +1,23 @@ +--- +sidebar_position: 2 +--- + +# Verified apps +In horsy you can see verified apps. + +You can distinguish verified apps from unverified ones by name, you will see `✅` next to app name. + +## How we verify apps +We choose app and check if it has source code. If it has, we check if it is not infected. + +Then, we install app on our virtual machine and check its functionality. If it works and usefull, we mark it as verified. + +## What it means for users +If app is verified, it means that app was downloaded by creators of horsy and checked how it works. + +This doesn't mean that app is safe, it may contain malicious code, because developer can update app without your knowledge. + +## For developers - how to get your app verified +If you want to get your app verified, you need to add source code to your app. + +We check apps in random order in our database, so how fast you can get verified app is not guaranteed, but if you are lucky and your app name and description are catchy, you will get verified app. diff --git a/docs/legacy/more/virustotal.md b/docs/legacy/more/virustotal.md new file mode 100644 index 0000000..ccefd79 --- /dev/null +++ b/docs/legacy/more/virustotal.md @@ -0,0 +1,45 @@ +--- +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/legacy/more/virustotal/signup_button.png) + +Create account and open this in menu: + +![API key tab](/img/legacy/more/virustotal/apikey_button.png) + +Copy your api key: + +![API key](/img/legacy/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 +While installing app, horsy will upload file to VirusTotal and give you scan results. + +If main file is infected, horsy will say you about it. + +If dependencies are infected, horsy will say you about it and pause installation. +If you use CLI or TUI, you can just press `Enter` to resume installation. +If you use GUI, you can't install apps with malicious dependencies. diff --git a/docs/legacy/users/_category_.json b/docs/legacy/users/_category_.json new file mode 100644 index 0000000..7150cd4 --- /dev/null +++ b/docs/legacy/users/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "For users", + "position": 2 +} diff --git a/docs/legacy/users/app-info.md b/docs/legacy/users/app-info.md new file mode 100644 index 0000000..0de090e --- /dev/null +++ b/docs/legacy/users/app-info.md @@ -0,0 +1,40 @@ +--- +sidebar_position: 4 +--- + +# Getting information + +You found interesting app, but you don't know anything about it? + +It's great idea to get information about it. + +## CLI +``` +horsy info +``` + +## TUI +``` +horsy +7 + +``` + +## GUI +Search for app in `Browse` tab + +Select needed app + +Click `Info` button or double click on app + +## What happens +You will see popup window (if you are using gui) or text (if CLI/TUI) with app information + +It seems to be something like this: +``` +<✅ if app verified else nothing> by + +👍 | 👎 +``` + +More about verified apps you can see **[here](/docs/more/verification)** diff --git a/docs/legacy/users/first-gui-launch.md b/docs/legacy/users/first-gui-launch.md new file mode 100644 index 0000000..818a453 --- /dev/null +++ b/docs/legacy/users/first-gui-launch.md @@ -0,0 +1,43 @@ +--- +sidebar_position: 2 +--- + +# First GUI launch + +So, you installd GUI. You can see desktop shortcut for ```horsy GUI```, also you can use terminal to launch it, type +``` +horsygui +``` + +Whis will run ```horsygui.exe``` with console, and if you have default terminal, it will hide terminal window. If you have custom terminal, something like ```Windows Terminal``` (default on Windows 11), horsy won't hide it. + +If you launch it first time, you will empty installed window, something like this: + +![Empty installed window](/img/legacy/for-users/first-gui-launch/empty-installed.png) + +If you see strange laggs - don't worry. If noone uses server, it stops itself, so now it loads, it will take several seconds. + +So let's install some apps! + +We installed ```drawhorse``` in CLI guide, so let's install ```kotogamescam``` - free open-source memory scanner/debugger + +Click ```Browse``` tab. + +In search box, type app name. We use `Algolia` for searching, so you can type two-three letters, search by description and even dependencies. + +![Search](/img/legacy/for-users/first-gui-launch/kotosearch.png) + +Press `Search` button. + +![Found](/img/legacy/for-users/first-gui-launch/found.png) + +Now, select `kotogamescam` app and press `Install` button + +You will see logs box and it will say you all about downloading and installing process. + +Now you see +``` +All done! + You can run your app by entering kotogamescam in terminal +``` +It means that everything is OK and you now cat run kotogamescam just entering `kotogamescam` in terminal! diff --git a/docs/legacy/users/first-launch.md b/docs/legacy/users/first-launch.md new file mode 100644 index 0000000..9ffee5b --- /dev/null +++ b/docs/legacy/users/first-launch.md @@ -0,0 +1,42 @@ +--- +sidebar_position: 1 +--- + +# First launch + +We are sure that you are eager to run horsy and initialize your first app installation. So let's start! + +First, open your Terminal. If you can't stand CLI apps, skip this tutorial and read next ```First GUI launch```. + +horsy is very user-friendly app, so you have choise at every step of using The Best Package Manager! + +Now type this in your terminal: +``` +horsy +``` +Yes. Just ```horsy```. You will see beautifull ASCII horsy logo and TextUI (TUI), where you can choose number option. + +Another way to use horsy is CLI. It works like +``` +horsy [command] +``` +For example: +``` +horsy install drawhorse +``` +or +``` +horsy i drawhorse +``` + +If you prefer using TUI, type ```0``` (option for install app) and type, for example ```drawhorse``` + +horsy will install the newest version of app + +VirusTotal configuring is availible **[here](/docs/more/virustotal)**. + +If everything is OK, you will see +``` +[OK] All done! +You can run your app by entering drawhorse in terminal +``` diff --git a/docs/legacy/users/like-dislike.md b/docs/legacy/users/like-dislike.md new file mode 100644 index 0000000..dcf90a5 --- /dev/null +++ b/docs/legacy/users/like-dislike.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 6 +--- + +# Likes and dislikes + +You express your opinion by liking and disliking any app. + +Users will see likes and dislikes in information. + +## CLI +``` +horsy like +horsy dislike +``` + +## TUI +Not availible + +## GUI +Search for app in `Browse` tab + +Select needed app + +Click `👍` or `👎` button + +## What happens +horsy sends like or dislike request. + +If you already liked or disliked this app, horsy will say you about it. +You CAN like and dislike same package at the same time! diff --git a/docs/legacy/users/search.md b/docs/legacy/users/search.md new file mode 100644 index 0000000..a8dc954 --- /dev/null +++ b/docs/legacy/users/search.md @@ -0,0 +1,26 @@ +--- +sidebar_position: 3 +--- + +# Search app +We use Algolia to index our content and search it. + +So, you can search for anything you want. + +# CLI +``` +horsy search +``` +Query can be part of app name or description. + +# TUI +``` +horsy +6 + +``` + +# GUI +Open `Browse` tab + +In `Search packages` type your query and press `Search` button diff --git a/docs/legacy/users/sources.md b/docs/legacy/users/sources.md new file mode 100644 index 0000000..38e4e7e --- /dev/null +++ b/docs/legacy/users/sources.md @@ -0,0 +1,31 @@ +--- +sidebar_position: 5 +--- + +# Getting sources + +The best thing about horsy - open-source. We encourage developers adding sources of their apps, so you can get them! + +## CLI +``` +horsy source +``` + +## TUI +``` +horsy +3 + +``` + +## GUI +Search for app in `Browse` tab + +Select needed app + +Click `Get source` button + +## What happens +If developer provided app sources, you will see browser with sources link + +If not, horsy will notify you diff --git a/docs/legacy/users/uninstalling.md b/docs/legacy/users/uninstalling.md new file mode 100644 index 0000000..34e0ea8 --- /dev/null +++ b/docs/legacy/users/uninstalling.md @@ -0,0 +1,36 @@ +--- +sidebar_position: 7 +--- + +# Uninstalling app + +So, for some reasons, you decided to uninstall package. + +We provide you this option. + +## CLI +``` +horsy uninstall +``` +or +``` +horsy un +``` + +## TUI +``` +horsy +1 + +``` + +## GUI +Select app in `Installed` tab + +Select needed app + +Click `Uninstall` button + +## What happens +Horsy will delete app folder from `apps` folder and remove it from `installed` list. +Also it will remove launch script. diff --git a/docs/legacy/users/updating.md b/docs/legacy/users/updating.md new file mode 100644 index 0000000..b763d78 --- /dev/null +++ b/docs/legacy/users/updating.md @@ -0,0 +1,41 @@ +--- +sidebar_position: 8 +--- + +# Updating app + +# CLI, TUI +You can check updates by running: +``` +horsy u +``` +or +``` +horsy updates +``` +TUI: +``` +horsy +2 +``` + +You will see output like this: +``` +Use following commands to update apps: + +horsy i autobridge +horsy i drawhorse +horsy i kotogamescam +horsy i wordython +``` +Copy commands and run them in terminal. + +# GUI +Press `Check all updates` in `Installed` tab + +App that have new version will be highlighted with `!` symbol before name. + +Click `Update` button on these apps + +## What happens +horsy will download newest version of app and replace old one diff --git a/docs/more/virustotal.md b/docs/more/virustotal.md index ccefd79..8e2feaf 100644 --- a/docs/more/virustotal.md +++ b/docs/more/virustotal.md @@ -10,15 +10,15 @@ 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/legacy/more/virustotal/signup_button.png) +![VirusTotal sign up](/img/more/virustotal/signup_button.png) Create account and open this in menu: -![API key tab](/img/legacy/more/virustotal/apikey_button.png) +![API key tab](/img/more/virustotal/apikey_button.png) Copy your api key: -![API key](/img/legacy/more/virustotal/apikey.png) +![API key](/img/more/virustotal/apikey.png) It is 64-character long string from random numbers and letters, for example `0f000f0000f00f000000f0000f0000f00f0000f0000f00f0f0000f0f000f00f0` @@ -28,12 +28,14 @@ Open terminal and type: ``` horsy --vt ``` +Or simply paste it in `Virustotal api key` box in `Settings` tab and press `Save` button. ## Disabling Open terminal and type: ``` horsy --vt disable ``` +Or remove it from box in `Settings` tab and press `Save` button. ## Functionality While installing app, horsy will upload file to VirusTotal and give you scan results. diff --git a/docs/users/first-gui-launch.md b/docs/users/first-gui-launch.md index 818a453..a9530e5 100644 --- a/docs/users/first-gui-launch.md +++ b/docs/users/first-gui-launch.md @@ -13,7 +13,7 @@ Whis will run ```horsygui.exe``` with console, and if you have default terminal, If you launch it first time, you will empty installed window, something like this: -![Empty installed window](/img/legacy/for-users/first-gui-launch/empty-installed.png) +![Empty installed window](/img/for-users/first-gui-launch/empty-installed.png) If you see strange laggs - don't worry. If noone uses server, it stops itself, so now it loads, it will take several seconds. @@ -25,11 +25,11 @@ Click ```Browse``` tab. In search box, type app name. We use `Algolia` for searching, so you can type two-three letters, search by description and even dependencies. -![Search](/img/legacy/for-users/first-gui-launch/kotosearch.png) +![Search](/img/for-users/first-gui-launch/kotosearch.png) Press `Search` button. -![Found](/img/legacy/for-users/first-gui-launch/found.png) +![Found](/img/for-users/first-gui-launch/found.png) Now, select `kotogamescam` app and press `Install` button diff --git a/static/img/developers/changing-credentials/email.png b/static/img/developers/changing-credentials/email.png new file mode 100644 index 0000000..bb8e43f 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..b16b07b 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..67c8644 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..1771e91 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..ea0f5b4 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/file-req/dl-button.png b/static/img/developers/file-req/dl-button.png new file mode 100644 index 0000000..283a9b9 Binary files /dev/null and b/static/img/developers/file-req/dl-button.png differ diff --git a/static/img/developers/file-req/nodejszxxxc.png b/static/img/developers/file-req/nodejszxxxc.png new file mode 100644 index 0000000..852aa9b Binary files /dev/null and b/static/img/developers/file-req/nodejszxxxc.png differ diff --git a/static/img/developers/file-req/zxcpython.png b/static/img/developers/file-req/zxcpython.png new file mode 100644 index 0000000..5500d9d Binary files /dev/null and b/static/img/developers/file-req/zxcpython.png differ diff --git a/static/img/developers/gui-uploading/form-filled.png b/static/img/developers/gui-uploading/form-filled.png new file mode 100644 index 0000000..85067bd Binary files /dev/null and b/static/img/developers/gui-uploading/form-filled.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..c1a476d Binary files /dev/null and b/static/img/developers/gui-uploading/login.jpg differ diff --git a/static/img/for-users/first-gui-launch/empty-installed.png b/static/img/for-users/first-gui-launch/empty-installed.png new file mode 100644 index 0000000..75005ed Binary files /dev/null and b/static/img/for-users/first-gui-launch/empty-installed.png differ diff --git a/static/img/for-users/first-gui-launch/found.png b/static/img/for-users/first-gui-launch/found.png new file mode 100644 index 0000000..136678a Binary files /dev/null and b/static/img/for-users/first-gui-launch/found.png differ diff --git a/static/img/for-users/first-gui-launch/kotosearch.png b/static/img/for-users/first-gui-launch/kotosearch.png new file mode 100644 index 0000000..f30df5c Binary files /dev/null and b/static/img/for-users/first-gui-launch/kotosearch.png differ diff --git a/static/img/installation/installer.png b/static/img/installation/installer.png new file mode 100644 index 0000000..b0abfb1 Binary files /dev/null and b/static/img/installation/installer.png 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