Skip to content

Commit 773b30f

Browse files
committed
Update local development instructions and gitignore
1 parent 00b5ca5 commit 773b30f

File tree

3 files changed

+10
-6
lines changed

3 files changed

+10
-6
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ ENV/
8989
# Rope project settings
9090
.ropeproject
9191

92+
# Local development files
93+
localconfig.env.py
9294
config.py
9395
data.db
9496

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,12 +67,16 @@ an Openshift Origin cluster.
6767
```
6868

6969
## Local Development
70-
Below are instructions for running gallery locally. It assumes that you have already forked and cloned this repository onto your local machine.
70+
Below are instructions for running gallery locally. It assumes that you have already forked and cloned this repository onto your local machine, and have Python3 installed.
7171

7272
1. Change the line in `__init__.py` that sets the config file from `config.env.py` to `localconfig.env.py`.
7373

74-
2. Get gallery dev secrets from an RTP and fill in `localconfig.env.py`. *DO NOT COMMIT THESE TO GIT*
74+
2. Copy `localconfig-sample.env.py` to `localconfig.env.py`, get gallery dev secrets from an RTP, and fill in.
7575

76-
3. Run `pip install -r requirements.txt`
76+
3. Create a [virtual environment](https://docs.python.org/3/library/venv.html), `python3 -m venv venv`
7777

78-
4. Run `python3 wsgi.py`
78+
4. `source venv/bin/activate` to enter the virtual environment
79+
80+
5. `pip install -r requirements.txt`
81+
82+
6. `python3 wsgi.py`

localconfig.env.py renamed to localconfig-sample.env.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,10 +8,8 @@
88
SECRET_KEY = os.environ.get('GALLERY_SECRET_KEY', '')
99

1010
# LDAP config
11-
LDAP_URL=os.environ.get('GALLERY_LDAP_URL', 'ldaps://ldap.csh.rit.edu:636')
1211
LDAP_BIND_DN=os.environ.get('GALLERY_LDAP_BIND_DN', '')
1312
LDAP_BIND_PW=os.environ.get('GALLERY_LDAP_BIND_PW', '')
14-
LDAP_USER_OU=os.environ.get('GALLERY_LDAP_USER_OU', 'ou=Users,dc=csh,dc=rit,dc=edu')
1513

1614
# OpenID Connect SSO config
1715
OIDC_ISSUER = os.environ.get('GALLERY_OIDC_ISSUER', 'https://sso.csh.rit.edu/auth/realms/csh')

0 commit comments

Comments
 (0)