parent
6fda3f1022
commit
5bb229b08d
@ -0,0 +1,13 @@
|
||||
---
|
||||
import { marked } from "marked";
|
||||
|
||||
const README = await fetch("https://raw.githubusercontent.com/Facinorous-420/dick/master/README.md")
|
||||
.then((res) => res.text())
|
||||
.then((data) => {
|
||||
return data
|
||||
})
|
||||
.catch((err) => console.log("fetch error", err))
|
||||
|
||||
---
|
||||
|
||||
<div set:html={marked(README)}></div>
|
||||
@ -1,7 +0,0 @@
|
||||
---
|
||||
title: Admin Panel
|
||||
description: Admin panel information
|
||||
layout: ../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
*Added in v1.1.0*
|
||||
@ -0,0 +1,25 @@
|
||||
---
|
||||
title: App Settings
|
||||
description: App settings information
|
||||
layout: ../../../layouts/MainLayout.astro
|
||||
---
|
||||
<p style="color: orange;">Admin Only Feature</p>
|
||||
|
||||
This is the main tab of the `Admin Dashboard`, and allows an administrator to edit their DICK and ASS settings.
|
||||
|
||||
## Main Settings
|
||||
|
||||
The tab allows the administrator to white label their instance, to read more check out the [white label documentation page](/dick-docs/en/configs/whitelabel).
|
||||
|
||||
As well as this, they can enable hCaptcha and configure it:
|
||||
|
||||
#### hCaptcha Enabled
|
||||
If enabled, your instance will use hCaptcha for the login and register pages, if disabled it will only send failed logins to a Rick Roll.
|
||||
|
||||
#### hCaptcha Site ID
|
||||
This is the hcaptcha site id if you plan to use hCaptcha as captcha to protect your DICK instance.
|
||||
|
||||
#### hCaptcha Secret Key
|
||||
This is the hcaptcha secret key found in your hcaptcha account if you plan to use hCaptcha as captcha to protect your DICK instance.
|
||||
|
||||
*Added in v1.1.0*
|
||||
@ -1,7 +1,11 @@
|
||||
---
|
||||
title: Users Panel
|
||||
description: Admin user configuration information
|
||||
title: Users Management
|
||||
description: Admin user management information
|
||||
layout: ../../../layouts/MainLayout.astro
|
||||
---
|
||||
<p style="color: orange;">Admin Only Feature</p>
|
||||
|
||||
This tab is inside of the `Admin Dashboard` page and shows a list of all users added in your ASS instance, as well as their roles.<br/>
|
||||
This page allows the user to create a new user, as well as delete already made ones.
|
||||
|
||||
*Added in v1.1.0*
|
||||
|
||||
@ -1,28 +0,0 @@
|
||||
---
|
||||
title: Installation
|
||||
description: Docs intro
|
||||
layout: ../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
## About The Project
|
||||
r
|
||||
Dick was created to be an easy to use front end for <a href="https://github.com/tycrek/ass">Ass</a> as there was no public option to allow users to view their saved images on their server. I decided to learn tailwind and also at the same time build this. I did this all in my spare time, and will keep updating as best as I can while I use it. I'm still learning all this so if anyone has suggestions on how to do things better, I am all ears! I love learning! :)
|
||||
|
||||
**Current Feautres:**
|
||||
1. General statistics on your file uploads
|
||||
2. File browser, allows you to see all your uploads on one webpage
|
||||
3. Deletion of items
|
||||
4. Copy link of items
|
||||
5. Customize DICK (completely white label)
|
||||
6. Register new ASS users
|
||||
7. hCaptcha on login and register pages <a href="https://www.hcaptcha.com/">You can learn more here</a>.
|
||||
|
||||
## Deploying
|
||||
|
||||
You have a few options for deploying DICK, depending on your needs.
|
||||
|
||||
[Production - Source](/en/installation/production/source)
|
||||
|
||||
[Production - Docker](/en/installation/production/docker)
|
||||
|
||||
[Development - Source](/en/installation/development/source)
|
||||
@ -0,0 +1,8 @@
|
||||
---
|
||||
description: DICK Introduction
|
||||
layout: ../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
import README from "../../components/Content/README.astro";
|
||||
|
||||
<README />
|
||||
@ -1,14 +0,0 @@
|
||||
---
|
||||
title: Source Installation
|
||||
description: Install and run DICK from source for development
|
||||
layout: ../../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
1. Create a folder, call it whatever you wish
|
||||
2. Install, and run ASS https://github.com/tycrek/ass#installation (This will create an `ass` folder)
|
||||
3. Go back into the folder you created and clone this repo `git clone https://github.com/Facinorous-420/dick`
|
||||
4. Go into the newly created `dick` folder `cd dick`
|
||||
5. Go into `/src` and copy `constants.ts.example` to `constants.ts` and edit it as needed
|
||||
6. Go back to the root of `dick` and install the dependancies for the frontend, `npm i`
|
||||
7. Run `npm run build:dev` to compile the code base in watch mode
|
||||
8. In a new terminal, run `npm run serve:dev` to run DICK using nodemon
|
||||
@ -0,0 +1,23 @@
|
||||
---
|
||||
title: Docker Installation
|
||||
description: Install and run DICK from Docker for production
|
||||
layout: ../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
DICK currently has a `Dockerfile` and `docker-compose.yml` included in the repo for easy set up in Docker environments. To get started:
|
||||
|
||||
1. Clone this repository:
|
||||
|
||||
git clone https://github.com/Facinorous-420/dick.git
|
||||
|
||||
2. Go into the newly created `dick` folder:
|
||||
|
||||
cd dick
|
||||
|
||||
3. Edit the config file to let DICK know how to connect to your ASS instance
|
||||
|
||||
4. Edit the `docker-compose.yml` to match your specific needs by changing the port, and volume location where your ass files are on your system
|
||||
|
||||
5. Run the docker compose file, this will create a new container and image named `dick`:
|
||||
|
||||
docker-compose up -d
|
||||
@ -1,14 +0,0 @@
|
||||
---
|
||||
title: Docker Installation
|
||||
description: Install and run DICK from Docker for production
|
||||
layout: ../../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
1. Create a folder, call it whatever you wish
|
||||
2. Install, and run ASS https://github.com/tycrek/ass#installation (This will create an `ass` folder)
|
||||
3. Go back into the folder you created and clone this repo `git clone https://github.com/Facinorous-420/dick.git`
|
||||
4. Go into the newly created `dick` folder `cd dick`
|
||||
5. Go into `/src` and copy `constants.ts.example` to `constants.ts` and edit it as needed
|
||||
6. Go back to the root of `dick` and edit the `docker-compose.yml` to match your specific needs by changing the port, and voluime location where your ass files are on your system.
|
||||
7. Run the docker compose file `docker-compose up -d` this will create a new container named `dick`.
|
||||
8.
|
||||
@ -1,13 +0,0 @@
|
||||
---
|
||||
title: Source Installation
|
||||
description: Install and run DICK from source for production
|
||||
layout: ../../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
1. Create a folder, call it whatever you wish
|
||||
2. Install, and run ASS https://github.com/tycrek/ass#installation (This will create an `ass` folder)
|
||||
3. Go back into the folder you created and clone this repo `git clone https://github.com/Facinorous-420/dick.git`
|
||||
4. Go into the newly created `dick` folder `cd dick`
|
||||
5. Go into `/src` and copy `constants.ts.example` to `constants.ts` and edit it as needed
|
||||
6. Go back to the root of `dick` and install the dependancies for the frontend, `npm i`
|
||||
7. Run `npm start` to compile the code base and run DICK
|
||||
@ -0,0 +1,38 @@
|
||||
---
|
||||
title: Source Installation
|
||||
description: Install and run DICK from source for production
|
||||
layout: ../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
DICK can be installed locally through source if you have `Node >=v16.14.0`:
|
||||
|
||||
1. Clone this repository:
|
||||
|
||||
git clone https://github.com/Facinorous-420/dick.git
|
||||
|
||||
2. Go into the newly created `dick` folder:
|
||||
|
||||
cd dick
|
||||
|
||||
3. Edit the config file to let DICK know how to connect to your ASS instance
|
||||
|
||||
4. Go back to the root of `dick` and install the dependencies for the frontend:
|
||||
|
||||
npm i
|
||||
|
||||
5. Lastly we can start DICK:
|
||||
|
||||
npm start
|
||||
|
||||
___
|
||||
|
||||
To keep your DICK up persistantly, you can use `pm2`:
|
||||
|
||||
1. Install `pm2` using `npm`:
|
||||
|
||||
npm i -g pm2
|
||||
|
||||
2. Run it using `pm2`:
|
||||
|
||||
pm2 start app.config.json && pm2 list
|
||||
|
||||
@ -0,0 +1,59 @@
|
||||
---
|
||||
title: Contributing
|
||||
description: How to contribute
|
||||
layout: ../../../layouts/MainLayout.astro
|
||||
---
|
||||
|
||||
## General Contributing Guidelines
|
||||
|
||||
Sometimes the easiest way to get your ideas added are to add them yourself. I am always happy to accept PRs for adding features, bug fixes, or code clean up. Let's just work together to keep this project organized!
|
||||
|
||||
<sub> If using VSCode, I'd recommend using this extension: https://marketplace.visualstudio.com/items?itemName=GitHub.vscode-pull-request-github</sub>
|
||||
|
||||
To get started, to break down the process of forking to creating the PR, there are 5 basic steps as detailed below:
|
||||
|
||||
1. Fork the Project
|
||||
2. Create your Branch (`git checkout -b feature/AmazingFeature`)
|
||||
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
|
||||
4. Push to the Branch (`git push origin feature/AmazingFeature`)
|
||||
5. Open a Pull Request
|
||||
|
||||
## PR Types
|
||||
|
||||
There are 3 types of PRs that you can make, `Feature`, `Bug Fix`, and `Clean Up`.
|
||||
|
||||
When creating the PR, please use this format: `<F/B/C> {title}`<br/>
|
||||
An example title for a feature PR would be `<F> Deletion of users from Admin dashboard`
|
||||
|
||||
Please include a detailed description of what this PR is doing, and why it is doing what it is doing.<br/>
|
||||
- If it's a `bug fix`, please explain what the issue was (point to an issue is enough) and what was done to fix it.<br/>
|
||||
- If it's a `feature`, please explain what you added, and why a user may want this feature. Optionally, to help push your feature in faster, include a PR to edit this documentation to document your new feature and link to it in the feature PR.<br/>
|
||||
- If it's `code clean up`, please explain why you are doing the clean up such as why you are deleting a feature.
|
||||
|
||||
## Running The Development Setup
|
||||
|
||||
Running the project for development purposes is super easy.
|
||||
|
||||
1. Clone this repository:
|
||||
|
||||
git clone https://github.com/Facinorous-420/dick.git
|
||||
|
||||
2. Go into the newly created `dick` folder:
|
||||
|
||||
cd dick
|
||||
|
||||
3. Edit the config file to let DICK know how to connect to your ASS instance, hopefully not a production one
|
||||
|
||||
4. Go back to the root of `dick` and install the dependencies for the frontend:
|
||||
|
||||
npm i
|
||||
|
||||
5. Lastly we can start DICK in development mode:
|
||||
|
||||
npm start:dev
|
||||
|
||||
Runs the app in the development mode.\
|
||||
Open [http://127.0.0.1:3000](http://127.0.0.1:3000) to view it in the browser.
|
||||
|
||||
The page will reload if you make edits.\
|
||||
You will also see any lint errors in the console.
|
||||
@ -1,5 +1,5 @@
|
||||
<script is:inline>
|
||||
// Redirect your homepage to the first page of documentation.
|
||||
// If you have a landing page, remove this script and add it here!
|
||||
window.location.pathname = `/en/installation`;
|
||||
window.location.pathname = `/dick-docs/en/`;
|
||||
</script>
|
||||
|
||||
Loading…
Reference in new issue