Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Selfhosting for Windows Page #7

Open
wants to merge 7 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion public/markdown/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ The bot will only listen to music commands invoked in channels it can actually *
If you want to restrict the bot to a specific role, you can always just restrict the bot to a channel only accessible by a specific set of roles.

## How do I selfhost the bot?
FredBoat was not originally written to be easily set up for selfhosting, but due to popular demand [I have written a tutorial.](http://docs.fredboat.com/selfhosting)
FredBoat was not originally written to be easily set up for selfhosting, but due to popular demand [I have written a tutorial.](http://docs.fredboat.com/selfhosting_linux)

## The music bot is telling me it doesn't have permission to connect/play music. How do I give it permission?
You are trying to play music in a voice channel, but your __Discord server permissions__ prevents it from connecting or speaking. You would need to change the permissions of the channel to allow the bot to connect and speak, as you would do with a user. For official help on this topic, see [Discord's support center](https://support.discordapp.com/hc/en-us/articles/206029707).
Expand Down
4 changes: 2 additions & 2 deletions public/markdown/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,12 @@ Let us know if you want other sites supported.
We invite everyone to join FredBoat hangout, which is a place to discuss suggestions and request for support. I'm very willing to take suggestions for the bot so don't hesitate to say what you have in mind! [Click here to join!](https://discord.gg/cgPFW4q)

## Support
Before you do anything, please [read our FAQ](https://docs.fredboat.com/faq).
Before you do anything, please [read our FAQ](https://fredboat.com/docs/faq).

You can join either our [Discord server](https://discord.gg/cgPFW4q) or tweet us at [@DiscordFredBoat](https://twitter.com/DiscordFredBoat).

## Legal
By using any of my hosted (but not selfhosted) bots you are subject to our (very minimal!) [terms of service](http://docs.fredboat.com/terms).
By using any of my hosted (but not selfhosted) bots you are subject to our (very minimal!) [terms of service](https://fredboat.com/docs/terms).

Effective as of 25-apr-2017.

Expand Down
2 changes: 1 addition & 1 deletion public/markdown/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ FredBoat uses 4 different ranks each with different permissions.

* 3: Admin

*Can change [FredBoat configuration](https://docs.fredboat.com/configuration) and edit permissions*
*Can change [FredBoat configuration](https://fredboat.com/docs/configuration) and edit permissions*

* 2: DJ

Expand Down
54 changes: 51 additions & 3 deletions public/markdown/selfhosting.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ This is a tutorial for users who would like to host their own bot running Fredbo

#### This tutorial is for advanced users. If you can't figure out how to run this, please use the public FredBoat♪♪

## Intallation
## Linux

### Requirements

Expand All @@ -13,7 +13,7 @@ This is a tutorial for users who would like to host their own bot running Fredbo

3. [A registered Discord application](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)

4. Linux \(Windows works too, but this tutorial is targetted at Linux\)
4. Linux (See [Selfhosting(Windows)](https://fredboat.com/docs/selfhosting#Windows) for the Windows tutorial)

### Instructions
Clone the `master` branch of FredBoat recursively:
Expand All @@ -37,6 +37,54 @@ To run the bot you should set up a directory that looks like this:
└──config.yaml
```

## Windows

### Requirements

1. [Java 8 JDK](http://www.oracle.com/technetwork/java/javase/downloads/jdk8-downloads-2133151.html)

2. [Apache Maven](https://maven.apache.org/install.html)

3. [Git](https://www.atlassian.com/git/tutorials/install-git#windows)

4. [JDK and Maven added to your PATH](https://www.tutorialspoint.com/maven/maven_environment_setup.htm)

5. [A registered Discord application](https://github.com/reactiflux/discord-irc/wiki/Creating-a-discord-bot-&-getting-a-token)

6. Windows (See [Selfhosting(Linux)](https://fredboat.com/docs/selfhosting#Linux) for the Linux tutorial)

### Instructions
Open Command Prompt and go to the directory where you want to download the bot

For example if your Windows Account name was `Fred`; you would do:

```sh
cd C:\Users\Fred\Desktop
```

Now clone the `master` branch of FredBoat recursively:

```sh
git clone --recursive https://github.com/Frederikam/FredBoat.git
```

Now compile the bot:

```sh
cd FredBoat
mvn package shade:shade
```

To run the bot you should set up a directory that looks like this:

```
├──FredBoat-1.0.jar
├──credentials.yaml
└──config.yaml
```

## Setting up config and credentials

The compiled bot can be found in `FredBoat/FredBoat/target`. A sample `config.yaml` and an example `credentials.yaml` can be found in https://github.com/Frederikam/FredBoat/tree/master/FredBoat

In order to run the bot, you must first populate your bot with API credentials for Discord in the `credentials.yaml` file.
Expand Down Expand Up @@ -95,4 +143,4 @@ spotifySecret:
Once you are done configuring, run the bot with `java -jar -Xmx128m FredBoat-1.0.jar`.


[Follow this link](http://docs.fredboat.com/systemdservice) to find a tutorial on running FredBoat as a `systemd` service.
[Follow this link](https://fredboat.com/docs/systemdservice) to find a tutorial on running FredBoat as a `systemd` service.