diff --git a/.github/install-aws.md b/.github/install-aws.md new file mode 100644 index 00000000..35bc140b --- /dev/null +++ b/.github/install-aws.md @@ -0,0 +1,38 @@ +## Install Shuffle on AWS + +First, you need to create your own VPC for the same range of private IP addresses. + +**To create a VPC in AWS, follow these steps** + +1. Sign in to the AWS Management Console and open the Amazon VPC console at https://console.aws.amazon.com/vpc/. +2. In the top navigation bar, choose the region in which you want to create the VPC. +3. In the navigation pane, choose Your VPCs & Choose Create VPC. +4. Enter a name for your VPC in the Name tag field & Choose VPC and more option. +5. Specify the IPv4 CIDR block for your VPC. The CIDR block is the range of IP addresses that will be available for use within your VPC. You can specify any CIDR block that is: + - Between a /16 and /28 netmask (inclusive) + - Not currently in use +6. Specify the AZs, Number of public subnets & Number of private subnets. + +![image](https://user-images.githubusercontent.com/118437260/211500830-30c52dc0-0688-47f9-8ee7-eb7f9b31a9b8.png) + +7. Choose Yes, Create VPC. + +Your VPC will be created and will appear in the list of Your VPCs. By default, a VPC includes a default security group and a default network ACL. You can customize your VPC by adding subnets, security groups, network ACLs, and other resources. + + + +**To create an EC2 instance in AWS, follow these steps:** + +1. Sign in to the AWS Management Console and open the Amazon EC2 console at https://console.aws.amazon.com/ec2/. +2. In the top navigation bar, choose the region in which you want to create the instance. +3. In the navigation pane, choose Instances and Choose Launch Instance. +4. On the Choose an Amazon Machine Image (AMI) page, choose an AMI. An AMI is a template that contains the software configuration (operating system, application server, and applications) for your instance. +5. On the Choose an Instance Type page, choose the hardware configuration of your instance. +6. On the Select an existing key pair or create a new key pair dialog box, choose an existing key pair or create a new one. +7. On the network settings page and click on edit and select your VPC & subnet. +8. On the Configure Security Group page, configure the security group for your instance. A security group acts as a virtual firewall for your instance to control inbound and outbound traffic. + +![image](https://user-images.githubusercontent.com/118437260/211514598-1c95e459-b98a-4579-b3a7-a92bf36e9f50.png) + +9. On the Add Storage page, add storage to your instance. +10. Review your instance launch details and choose Launch. diff --git a/.github/install-guide.md b/.github/install-guide.md index 53e39401..48b3689e 100755 --- a/.github/install-guide.md +++ b/.github/install-guide.md @@ -1,7 +1,7 @@ # Installation guide Installation of Shuffle is currently only available in docker. Looking for how to update Shuffle? Check the [updating guide](https://shuffler.io/docs/configuration#updating_shuffle) -This document outlines a an introduction environment which is not scalable. [Read here](https://shuffler.io/docs/configuration#production_readiness) for information on production readiness. This also includes system requirements and configurations for Swarm or K8s. +This document outlines a an introduction environment which is not scalable. [Read here](https://shuffler.io/docs/configuration#production_readiness) for information on production readiness. This also includes system requirements and configurations for Swarm or Kubernetes. # Docker - *nix The Docker setup is done with docker-compose @@ -19,6 +19,7 @@ cd Shuffle ```bash mkdir shuffle-database sudo chown -R 1000:1000 shuffle-database +# IF you get an error using 'chown', add the user first with 'sudo useradd opensearch' ``` 4. Run docker-compose. @@ -26,7 +27,12 @@ sudo chown -R 1000:1000 shuffle-database docker-compose up -d ``` -When you're done, skip to the "After installation" step below. +5. Recommended for Opensearch to work well +```bash +sudo sysctl -w vm.max_map_count=262144 # https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html +``` + +When you're done, skip to the [After installation](#after-installation) step below. ## Windows with WSL This step is for setting up with Docker on windows from scratch. @@ -57,7 +63,7 @@ https://shuffler.io/docs/configuration 3. Sign in with the same Username & Password! Go to /apps and see if you have any apps yet. If not - you may need to [configure proxies](https://shuffler.io/docs/configuration#production_readiness) 4. Check out https://shuffler.io/docs/configuration as it has a lot of useful information to get started -![Admin account setup](https://github.com/frikky/Shuffle/blob/master/frontend/src/assets/img/shuffle_adminaccount.png) +![Admin account setup](https://github.com/Shuffle/Shuffle/blob/main/frontend/src/assets/img/shuffle_adminaccount.png?raw=true) ### Useful info * Check out [getting started](https://shuffler.io/docs/getting_started) diff --git a/.github/workflows/project_automation.yml b/.github/workflows/project_automation.yml new file mode 100644 index 00000000..0e3bf945 --- /dev/null +++ b/.github/workflows/project_automation.yml @@ -0,0 +1,16 @@ +name: Automation - Add all new issues to roadmap project + +on: + issues: + types: + - opened + +jobs: + add-to-project: + name: Add issue to project + runs-on: ubuntu-latest + steps: + - uses: actions/add-to-project@v0.5.0 + with: + project-url: https://github.com/orgs/Shuffle/projects/8 + github-token: ${{ secrets.ADD_TO_PROJECT_PAT }} diff --git a/README.md b/README.md index e937f939..797dd530 100755 --- a/README.md +++ b/README.md @@ -21,7 +21,7 @@ Follow us on Twitter at [@shuffleio](https://twitter.com/shuffleio). -![Example Shuffle webhook integration](https://github.com/frikky/Shuffle/blob/master/frontend/src/assets/img/github_shuffle_img.png) +![Example Shuffle webhook integration](https://github.com/frikky/Shuffle/blob/main/frontend/src/assets/img/github_shuffle_img.png) ## Try it * Self-hosted: Check out the [installation guide](https://github.com/frikky/shuffle/blob/master/.github/install-guide.md) @@ -96,7 +96,7 @@ Shuffle backend: AGPLv3 Apps, specification and App SDK: MIT ## Architecture -![Shuffle Architecture](https://github.com/frikky/Shuffle/blob/master/frontend/src/assets/img/shuffle_architecture.png) +![Shuffle Architecture](https://github.com/frikky/Shuffle/blob/main/frontend/src/assets/img/shuffle_architecture.png) ### Repository overview Below is the folder structure with a short explanation diff --git a/docker-compose.yml b/docker-compose.yml index 04d07033..9e66eb53 100755 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -62,7 +62,7 @@ services: container_name: shuffle-opensearch environment: - bootstrap.memory_lock=true - - "OPENSEARCH_JAVA_OPTS=-Xms1024m -Xmx1024m" # minimum and maximum Java heap size, recommend setting both to 50% of system RAM + - "OPENSEARCH_JAVA_OPTS=-Xms2048m -Xmx2048m" # minimum and maximum Java heap size, recommend setting both to 50% of system RAM - cluster.initial_master_nodes=shuffle-opensearch - cluster.routing.allocation.disk.threshold_enabled=false - cluster.name=shuffle-cluster diff --git a/frontend/package.json b/frontend/package.json index 7e25c17d..30683143 100755 --- a/frontend/package.json +++ b/frontend/package.json @@ -105,7 +105,7 @@ ], "devDependencies": { "prettier": "2.4.1", - "promise-window": "^1.2.1" + "promise-window": "^1.2.1", "@babel/core": "^7.15.8", "babel-eslint": "^10.1.0", "webpack": "^4.44.2", diff --git a/frontend/src/App.jsx b/frontend/src/App.jsx index d4e116ba..78fc0899 100755 --- a/frontend/src/App.jsx +++ b/frontend/src/App.jsx @@ -1,6 +1,5 @@ import React, { useState, useEffect } from "react"; -//import { Route, Routes } from "react-router"; import { Route, Routes, BrowserRouter } from "react-router-dom"; import { CookiesProvider } from "react-cookie"; import { removeCookies, useCookies } from "react-cookie";